diff options
Diffstat (limited to 'contrib/python')
121 files changed, 20761 insertions, 9588 deletions
diff --git a/contrib/python/boto3/py3/.dist-info/METADATA b/contrib/python/boto3/py3/.dist-info/METADATA index 90b1f6d93b6..f3b4112fb08 100644 --- a/contrib/python/boto3/py3/.dist-info/METADATA +++ b/contrib/python/boto3/py3/.dist-info/METADATA @@ -1,6 +1,6 @@ Metadata-Version: 2.1 Name: boto3 -Version: 1.35.99 +Version: 1.36.26 Summary: The AWS SDK for Python Home-page: https://github.com/boto/boto3 Author: Amazon Web Services @@ -23,9 +23,9 @@ Classifier: Programming Language :: Python :: 3.13 Requires-Python: >= 3.8 License-File: LICENSE License-File: NOTICE -Requires-Dist: botocore (<1.36.0,>=1.35.99) +Requires-Dist: botocore (<1.37.0,>=1.36.26) Requires-Dist: jmespath (<2.0.0,>=0.7.1) -Requires-Dist: s3transfer (<0.11.0,>=0.10.0) +Requires-Dist: s3transfer (<0.12.0,>=0.11.0) Provides-Extra: crt Requires-Dist: botocore[crt] (<2.0a0,>=1.21.0) ; extra == 'crt' diff --git a/contrib/python/boto3/py3/boto3/__init__.py b/contrib/python/boto3/py3/boto3/__init__.py index 3924854d111..674f16138fb 100644 --- a/contrib/python/boto3/py3/boto3/__init__.py +++ b/contrib/python/boto3/py3/boto3/__init__.py @@ -17,7 +17,7 @@ from boto3.compat import _warn_deprecated_python from boto3.session import Session __author__ = 'Amazon Web Services' -__version__ = '1.35.99' +__version__ = '1.36.26' # The default Boto3 session; autoloaded when needed. diff --git a/contrib/python/boto3/py3/ya.make b/contrib/python/boto3/py3/ya.make index 9acd27d643a..0028a728255 100644 --- a/contrib/python/boto3/py3/ya.make +++ b/contrib/python/boto3/py3/ya.make @@ -2,7 +2,7 @@ PY3_LIBRARY() -VERSION(1.35.99) +VERSION(1.36.26) LICENSE(Apache-2.0) diff --git a/contrib/python/botocore/py3/.dist-info/METADATA b/contrib/python/botocore/py3/.dist-info/METADATA index 4f032777728..0ef48999449 100644 --- a/contrib/python/botocore/py3/.dist-info/METADATA +++ b/contrib/python/botocore/py3/.dist-info/METADATA @@ -1,6 +1,6 @@ Metadata-Version: 2.1 Name: botocore -Version: 1.35.99 +Version: 1.36.26 Summary: Low-level, data-driven core of boto 3. Home-page: https://github.com/boto/botocore Author: Amazon Web Services @@ -27,7 +27,7 @@ Requires-Dist: python-dateutil (<3.0.0,>=2.1) Requires-Dist: urllib3 (<1.27,>=1.25.4) ; python_version < "3.10" Requires-Dist: urllib3 (!=2.2.0,<3,>=1.25.4) ; python_version >= "3.10" Provides-Extra: crt -Requires-Dist: awscrt (==0.22.0) ; extra == 'crt' +Requires-Dist: awscrt (==0.23.8) ; extra == 'crt' botocore ======== @@ -68,11 +68,11 @@ Assuming that you have Python and ``virtualenv`` installed, set up your environm $ git clone https://github.com/boto/botocore.git $ cd botocore - $ virtualenv venv + $ python -m venv .venv ... - $ . venv/bin/activate - $ pip install -r requirements.txt - $ pip install -e . + $ source .venv/bin/activate + $ python -m pip install -r requirements.txt + $ python -m pip install -e . .. code-block:: sh diff --git a/contrib/python/botocore/py3/README.rst b/contrib/python/botocore/py3/README.rst index 29649333219..21b5600a7bd 100644 --- a/contrib/python/botocore/py3/README.rst +++ b/contrib/python/botocore/py3/README.rst @@ -37,11 +37,11 @@ Assuming that you have Python and ``virtualenv`` installed, set up your environm $ git clone https://github.com/boto/botocore.git $ cd botocore - $ virtualenv venv + $ python -m venv .venv ... - $ . venv/bin/activate - $ pip install -r requirements.txt - $ pip install -e . + $ source .venv/bin/activate + $ python -m pip install -r requirements.txt + $ python -m pip install -e . .. code-block:: sh diff --git a/contrib/python/botocore/py3/botocore/__init__.py b/contrib/python/botocore/py3/botocore/__init__.py index 14bffecfcfc..f58707e778e 100644 --- a/contrib/python/botocore/py3/botocore/__init__.py +++ b/contrib/python/botocore/py3/botocore/__init__.py @@ -16,7 +16,7 @@ import logging import os import re -__version__ = '1.35.99' +__version__ = '1.36.26' class NullHandler(logging.Handler): diff --git a/contrib/python/botocore/py3/botocore/args.py b/contrib/python/botocore/py3/botocore/args.py index 7ffea80011e..b391433ab4b 100644 --- a/contrib/python/botocore/py3/botocore/args.py +++ b/contrib/python/botocore/py3/botocore/args.py @@ -61,6 +61,23 @@ LEGACY_GLOBAL_STS_REGIONS = [ # values result in a warning-level log message. USERAGENT_APPID_MAXLEN = 50 +VALID_REQUEST_CHECKSUM_CALCULATION_CONFIG = ( + "when_supported", + "when_required", +) +VALID_RESPONSE_CHECKSUM_VALIDATION_CONFIG = ( + "when_supported", + "when_required", +) + +PRIORITY_ORDERED_SUPPORTED_PROTOCOLS = ( + 'json', + 'rest-json', + 'rest-xml', + 'query', + 'ec2', +) + class ClientArgsCreator: def __init__( @@ -201,7 +218,7 @@ class ClientArgsCreator: scoped_config, ): service_name = service_model.endpoint_prefix - protocol = service_model.metadata['protocol'] + protocol = self._resolve_protocol(service_model) parameter_validation = True if client_config and not client_config.parameter_validation: parameter_validation = False @@ -271,12 +288,19 @@ class ClientArgsCreator: sigv4a_signing_region_set=( client_config.sigv4a_signing_region_set ), + request_checksum_calculation=( + client_config.request_checksum_calculation + ), + response_checksum_validation=( + client_config.response_checksum_validation + ), ) self._compute_retry_config(config_kwargs) self._compute_connect_timeout(config_kwargs) self._compute_user_agent_appid_config(config_kwargs) self._compute_request_compression_config(config_kwargs) self._compute_sigv4a_signing_region_set_config(config_kwargs) + self._compute_checksum_config(config_kwargs) s3_config = self.compute_s3_config(client_config) is_s3_service = self._is_s3_service(service_name) @@ -781,3 +805,53 @@ class ClientArgsCreator: 'sigv4a_signing_region_set' ) config_kwargs['sigv4a_signing_region_set'] = sigv4a_signing_region_set + + def _compute_checksum_config(self, config_kwargs): + self._handle_checksum_config( + config_kwargs, + config_key="request_checksum_calculation", + valid_options=VALID_REQUEST_CHECKSUM_CALCULATION_CONFIG, + ) + self._handle_checksum_config( + config_kwargs, + config_key="response_checksum_validation", + valid_options=VALID_RESPONSE_CHECKSUM_VALIDATION_CONFIG, + ) + + def _resolve_protocol(self, service_model): + # We need to ensure `protocols` exists in the metadata before attempting to + # access it directly since referencing service_model.protocols directly will + # raise an UndefinedModelAttributeError if protocols is not defined + if service_model.metadata.get('protocols'): + for protocol in PRIORITY_ORDERED_SUPPORTED_PROTOCOLS: + if protocol in service_model.protocols: + return protocol + raise botocore.exceptions.UnsupportedServiceProtocolsError( + botocore_supported_protocols=PRIORITY_ORDERED_SUPPORTED_PROTOCOLS, + service_supported_protocols=service_model.protocols, + service=service_model.service_name, + ) + # If a service does not have a `protocols` trait, fall back to the legacy + # `protocol` trait + return service_model.protocol + + def _handle_checksum_config( + self, + config_kwargs, + config_key, + valid_options, + ): + value = config_kwargs.get(config_key) + if value is None: + value = self._config_store.get_config_variable(config_key) + + if isinstance(value, str): + value = value.lower() + + if value not in valid_options: + raise botocore.exceptions.InvalidChecksumConfigError( + config_key=config_key, + config_value=value, + valid_options=valid_options, + ) + config_kwargs[config_key] = value diff --git a/contrib/python/botocore/py3/botocore/auth.py b/contrib/python/botocore/py3/botocore/auth.py index 366f5898117..9ee6490df5b 100644 --- a/contrib/python/botocore/py3/botocore/auth.py +++ b/contrib/python/botocore/py3/botocore/auth.py @@ -65,6 +65,7 @@ ISO8601 = '%Y-%m-%dT%H:%M:%SZ' SIGV4_TIMESTAMP = '%Y%m%dT%H%M%SZ' SIGNED_HEADERS_BLACKLIST = [ 'expect', + 'transfer-encoding', 'user-agent', 'x-amzn-trace-id', ] diff --git a/contrib/python/botocore/py3/botocore/compat.py b/contrib/python/botocore/py3/botocore/compat.py index 43b3be320ef..e1b9d6456e6 100644 --- a/contrib/python/botocore/py3/botocore/compat.py +++ b/contrib/python/botocore/py3/botocore/compat.py @@ -296,6 +296,21 @@ except ImportError: HAS_CRT = False +def has_minimum_crt_version(minimum_version): + """Not intended for use outside botocore.""" + if not HAS_CRT: + return False + + crt_version_str = awscrt.__version__ + try: + crt_version_ints = map(int, crt_version_str.split(".")) + crt_version_tuple = tuple(crt_version_ints) + except (TypeError, ValueError): + return False + + return crt_version_tuple >= minimum_version + + ######################################################## # urllib3 compat backports # ######################################################## diff --git a/contrib/python/botocore/py3/botocore/config.py b/contrib/python/botocore/py3/botocore/config.py index eee55bb06d0..0d20b69b8f6 100644 --- a/contrib/python/botocore/py3/botocore/config.py +++ b/contrib/python/botocore/py3/botocore/config.py @@ -235,6 +235,37 @@ class Config: specified service will be ignored. Defaults to None. + + :type request_checksum_calculation: str + :param request_checksum_calculation: Determines when a checksum will be + calculated for request payloads. Valid values are: + + * ``when_supported`` -- When set, a checksum will be calculated for + all request payloads of operations modeled with the ``httpChecksum`` + trait where ``requestChecksumRequired`` is ``true`` or a + ``requestAlgorithmMember`` is modeled. + + * ``when_required`` -- When set, a checksum will only be calculated + for request payloads of operations modeled with the ``httpChecksum`` + trait where ``requestChecksumRequired`` is ``true`` or where a + ``requestAlgorithmMember`` is modeled and supplied. + + Defaults to None. + + :type response_checksum_validation: str + :param response_checksum_validation: Determines when checksum validation + will be performed on response payloads. Valid values are: + + * ``when_supported`` -- When set, checksum validation is performed on + all response payloads of operations modeled with the ``httpChecksum`` + trait where ``responseAlgorithms`` is modeled, except when no modeled + checksum algorithms are supported. + + * ``when_required`` -- When set, checksum validation is not performed + on response payloads of operations unless the checksum algorithm is + supported and the ``requestValidationModeMember`` member is set to ``ENABLED``. + + Defaults to None. """ OPTION_DEFAULTS = OrderedDict( @@ -264,6 +295,8 @@ class Config: ('disable_request_compression', None), ('client_context_params', None), ('sigv4a_signing_region_set', None), + ('request_checksum_calculation', None), + ('response_checksum_validation', None), ] ) diff --git a/contrib/python/botocore/py3/botocore/configprovider.py b/contrib/python/botocore/py3/botocore/configprovider.py index 3c37fc35c5e..b52e5ce75c0 100644 --- a/contrib/python/botocore/py3/botocore/configprovider.py +++ b/contrib/python/botocore/py3/botocore/configprovider.py @@ -168,6 +168,18 @@ BOTOCORE_DEFAUT_SESSION_VARIABLES = { None, None, ), + 'request_checksum_calculation': ( + 'request_checksum_calculation', + 'AWS_REQUEST_CHECKSUM_CALCULATION', + "when_supported", + None, + ), + 'response_checksum_validation': ( + 'response_checksum_validation', + 'AWS_RESPONSE_CHECKSUM_VALIDATION', + "when_supported", + None, + ), } # Evaluate AWS_STS_REGIONAL_ENDPOINTS settings @@ -468,7 +480,7 @@ class ConfigValueStore: def get_config_variable(self, logical_name): """ - Retrieve the value associeated with the specified logical_name + Retrieve the value associated with the specified logical_name from the corresponding provider. If no value is found None will be returned. diff --git a/contrib/python/botocore/py3/botocore/data/accessanalyzer/2019-11-01/service-2.json b/contrib/python/botocore/py3/botocore/data/accessanalyzer/2019-11-01/service-2.json index fe4a7da3d61..6450c5f6dd3 100644 --- a/contrib/python/botocore/py3/botocore/data/accessanalyzer/2019-11-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/accessanalyzer/2019-11-01/service-2.json @@ -345,6 +345,24 @@ ], "documentation":"<p>Retrieves information about the specified finding. GetFinding and GetFindingV2 both use <code>access-analyzer:GetFinding</code> in the <code>Action</code> element of an IAM policy statement. You must have permission to perform the <code>access-analyzer:GetFinding</code> action.</p>" }, + "GetFindingsStatistics":{ + "name":"GetFindingsStatistics", + "http":{ + "method":"POST", + "requestUri":"/analyzer/findings/statistics", + "responseCode":200 + }, + "input":{"shape":"GetFindingsStatisticsRequest"}, + "output":{"shape":"GetFindingsStatisticsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"<p>Retrieves a list of aggregated finding statistics for an external access or unused access analyzer.</p>" + }, "GetGeneratedPolicy":{ "name":"GetGeneratedPolicy", "http":{ @@ -933,6 +951,12 @@ "max":100, "min":0 }, + "AccountAggregations":{ + "type":"list", + "member":{"shape":"FindingAggregationAccountDetails"}, + "max":10, + "min":1 + }, "AccountIdsList":{ "type":"list", "member":{"shape":"String"} @@ -1814,6 +1838,28 @@ }, "documentation":"<p>Contains information about an external access finding.</p>" }, + "ExternalAccessFindingsStatistics":{ + "type":"structure", + "members":{ + "resourceTypeStatistics":{ + "shape":"ResourceTypeStatisticsMap", + "documentation":"<p>The total number of active cross-account and public findings for each resource type of the specified external access analyzer.</p>" + }, + "totalActiveFindings":{ + "shape":"Integer", + "documentation":"<p>The number of active findings for the specified external access analyzer.</p>" + }, + "totalArchivedFindings":{ + "shape":"Integer", + "documentation":"<p>The number of archived findings for the specified external access analyzer.</p>" + }, + "totalResolvedFindings":{ + "shape":"Integer", + "documentation":"<p>The number of resolved findings for the specified external access analyzer.</p>" + } + }, + "documentation":"<p>Provides aggregate statistics about the findings for the specified external access analyzer.</p>" + }, "FilterCriteriaMap":{ "type":"map", "key":{"shape":"String"}, @@ -1895,6 +1941,29 @@ }, "documentation":"<p>Contains information about a finding.</p>" }, + "FindingAggregationAccountDetails":{ + "type":"structure", + "members":{ + "account":{ + "shape":"String", + "documentation":"<p>The ID of the Amazon Web Services account for which unused access finding details are provided.</p>" + }, + "numberOfActiveFindings":{ + "shape":"Integer", + "documentation":"<p>The number of active unused access findings for the specified Amazon Web Services account.</p>" + }, + "details":{ + "shape":"FindingAggregationAccountDetailsMap", + "documentation":"<p>Provides the number of active findings for each type of unused access for the specified Amazon Web Services account.</p>" + } + }, + "documentation":"<p>Contains information about the findings for an Amazon Web Services account in an organization unused access analyzer.</p>" + }, + "FindingAggregationAccountDetailsMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Integer"} + }, "FindingChangeType":{ "type":"string", "enum":[ @@ -2145,6 +2214,25 @@ "type":"list", "member":{"shape":"FindingSummaryV2"} }, + "FindingsStatistics":{ + "type":"structure", + "members":{ + "externalAccessFindingsStatistics":{ + "shape":"ExternalAccessFindingsStatistics", + "documentation":"<p>The aggregate statistics for an external access analyzer.</p>" + }, + "unusedAccessFindingsStatistics":{ + "shape":"UnusedAccessFindingsStatistics", + "documentation":"<p>The aggregate statistics for an unused access analyzer.</p>" + } + }, + "documentation":"<p>Contains information about the aggregate statistics for an external or unused access analyzer. Only one parameter can be used in a <code>FindingsStatistics</code> object.</p>", + "union":true + }, + "FindingsStatisticsList":{ + "type":"list", + "member":{"shape":"FindingsStatistics"} + }, "GenerateFindingRecommendationRequest":{ "type":"structure", "required":[ @@ -2552,6 +2640,29 @@ } } }, + "GetFindingsStatisticsRequest":{ + "type":"structure", + "required":["analyzerArn"], + "members":{ + "analyzerArn":{ + "shape":"AnalyzerArn", + "documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> used to generate the statistics.</p>" + } + } + }, + "GetFindingsStatisticsResponse":{ + "type":"structure", + "members":{ + "findingsStatistics":{ + "shape":"FindingsStatisticsList", + "documentation":"<p>A group of external access or unused access findings statistics.</p>" + }, + "lastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"<p>The time at which the retrieval of the findings statistics was last updated. If the findings statistics have not been previously retrieved for the specified analyzer, this field will not be populated.</p>" + } + } + }, "GetGeneratedPolicyRequest":{ "type":"structure", "required":["jobId"], @@ -3578,6 +3689,25 @@ "AWS::IAM::User" ] }, + "ResourceTypeDetails":{ + "type":"structure", + "members":{ + "totalActivePublic":{ + "shape":"Integer", + "documentation":"<p>The total number of active public findings for the resource type.</p>" + }, + "totalActiveCrossAccount":{ + "shape":"Integer", + "documentation":"<p>The total number of active cross-account findings for the resource type.</p>" + } + }, + "documentation":"<p>Contains information about the total number of active cross-account and public findings for a resource type of an external access analyzer.</p>" + }, + "ResourceTypeStatisticsMap":{ + "type":"map", + "key":{"shape":"ResourceType"}, + "value":{"shape":"ResourceTypeDetails"} + }, "RetiringPrincipal":{"type":"string"}, "RoleArn":{ "type":"string", @@ -4044,6 +4174,50 @@ }, "documentation":"<p>Contains information about an unused access analyzer.</p>" }, + "UnusedAccessFindingsStatistics":{ + "type":"structure", + "members":{ + "unusedAccessTypeStatistics":{ + "shape":"UnusedAccessTypeStatisticsList", + "documentation":"<p>A list of details about the total number of findings for each type of unused access for the analyzer. </p>" + }, + "topAccounts":{ + "shape":"AccountAggregations", + "documentation":"<p>A list of one to ten Amazon Web Services accounts that have the most active findings for the unused access analyzer.</p>" + }, + "totalActiveFindings":{ + "shape":"Integer", + "documentation":"<p>The total number of active findings for the unused access analyzer.</p>" + }, + "totalArchivedFindings":{ + "shape":"Integer", + "documentation":"<p>The total number of archived findings for the unused access analyzer.</p>" + }, + "totalResolvedFindings":{ + "shape":"Integer", + "documentation":"<p>The total number of resolved findings for the unused access analyzer.</p>" + } + }, + "documentation":"<p>Provides aggregate statistics about the findings for the specified unused access analyzer.</p>" + }, + "UnusedAccessTypeStatistics":{ + "type":"structure", + "members":{ + "unusedAccessType":{ + "shape":"String", + "documentation":"<p>The type of unused access.</p>" + }, + "total":{ + "shape":"Integer", + "documentation":"<p>The total number of findings for the specified unused access type.</p>" + } + }, + "documentation":"<p>Contains information about the total number of findings for a type of unused access.</p>" + }, + "UnusedAccessTypeStatisticsList":{ + "type":"list", + "member":{"shape":"UnusedAccessTypeStatistics"} + }, "UnusedAction":{ "type":"structure", "required":["action"], diff --git a/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/service-2.json b/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/service-2.json index 5058ebf46e9..eed460ebef9 100644 --- a/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/service-2.json @@ -470,7 +470,7 @@ }, "AWSPolicy":{ "type":"string", - "max":20480, + "max":81920, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, @@ -887,6 +887,14 @@ "CrlDistributionPointExtensionConfiguration":{ "shape":"CrlDistributionPointExtensionConfiguration", "documentation":"<p>Configures the behavior of the CRL Distribution Point extension for certificates issued by your certificate authority. If this field is not provided, then the CRl Distribution Point Extension will be present and contain the default CRL URL.</p>" + }, + "CrlType":{ + "shape":"CrlType", + "documentation":"<p>Specifies whether to create a complete or partitioned CRL. This setting determines the maximum number of certificates that the certificate authority can issue and revoke. For more information, see <a href=\"privateca/latest/userguide/pca.html#limits_pca\">Amazon Web Services Private CA quotas</a>.</p> <ul> <li> <p> <code>COMPLETE</code> - The default setting. Amazon Web Services Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason. Each certificate that Amazon Web Services Private CA issues is bound to a specific CRL through its CRL distribution point (CDP) extension, defined in <a href=\"https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.9\"> RFC 5280</a>.</p> </li> <li> <p> <code>PARTITIONED</code> - Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue. </p> <important> <p> When using partitioned CRLs, you must validate that the CRL's associated issuing distribution point (IDP) URI matches the certificate's CDP URI to ensure the right CRL has been fetched. Amazon Web Services Private CA marks the IDP extension as critical, which your client must be able to process. </p> </important> </li> </ul>" + }, + "CustomPath":{ + "shape":"CrlPathString", + "documentation":"<p>Designates a custom file path in S3 for CRL(s). For example, <code>http://<CustomName>/ <CustomPath>/<CrlPartition_GUID>.crl</code>. </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 by default copies the CNAME or the S3 bucket name to the <b>CRL Distribution Points</b> extension of each certificate it issues. If you want to configure this default behavior to be something different, you can set the <b>CrlDistributionPointExtensionConfiguration</b> parameter. Your S3 bucket policy must give write permission to Amazon Web Services Private CA. </p> <p>Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see <a href=\"https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html#crl-encryption\">Encrypting Your CRLs</a>.</p> <p>Your private CA uses the value in the <b>ExpirationInDays</b> parameter to calculate the <b>nextUpdate</b> field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.</p> <p>A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.</p> <p>CRLs contain the following fields:</p> <ul> <li> <p> <b>Version</b>: The current version number defined in RFC 5280 is V2. The integer value is 0x1. </p> </li> <li> <p> <b>Signature Algorithm</b>: The name of the algorithm used to sign the CRL.</p> </li> <li> <p> <b>Issuer</b>: The X.500 distinguished name of your private CA that issued the CRL.</p> </li> <li> <p> <b>Last Update</b>: The issue date and time of this CRL.</p> </li> <li> <p> <b>Next Update</b>: The day and time by which the next CRL will be issued.</p> </li> <li> <p> <b>Revoked Certificates</b>: List of revoked certificates. Each list item contains the following information.</p> <ul> <li> <p> <b>Serial Number</b>: The serial number, in hexadecimal format, of the revoked certificate.</p> </li> <li> <p> <b>Revocation Date</b>: Date and time the certificate was revoked.</p> </li> <li> <p> <b>CRL Entry Extensions</b>: Optional extensions for the CRL entry.</p> <ul> <li> <p> <b>X509v3 CRL Reason Code</b>: Reason the certificate was revoked.</p> </li> </ul> </li> </ul> </li> <li> <p> <b>CRL Extensions</b>: Optional extensions for the CRL.</p> <ul> <li> <p> <b>X509v3 Authority Key Identifier</b>: Identifies the public key associated with the private key used to sign the certificate.</p> </li> <li> <p> <b>X509v3 CRL Number:</b>: Decimal sequence number for the CRL.</p> </li> </ul> </li> <li> <p> <b>Signature Algorithm</b>: Algorithm used by your private CA to sign the CRL.</p> </li> <li> <p> <b>Signature Value</b>: Signature computed over the CRL.</p> </li> </ul> <p>Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.</p> <p> <code>openssl crl -inform DER -text -in <i>crl_path</i> -noout</code> </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html\">Planning a certificate revocation list (CRL)</a> in the <i>Amazon Web Services Private Certificate Authority User Guide</i> </p>" @@ -903,6 +911,19 @@ }, "documentation":"<p>Contains configuration information for the default behavior of the CRL Distribution Point (CDP) extension in certificates issued by your CA. This extension contains a link to download the CRL, so you can check whether a certificate has been revoked. To choose whether you want this extension omitted or not in certificates issued by your CA, you can set the <b>OmitExtension</b> parameter.</p>" }, + "CrlPathString":{ + "type":"string", + "max":253, + "min":0, + "pattern":"[-a-zA-Z0-9;?:@&=+$,%_.!~*()']+(/[-a-zA-Z0-9;?:@&=+$,%_.!~*()']+)*" + }, + "CrlType":{ + "type":"string", + "enum":[ + "COMPLETE", + "PARTITIONED" + ] + }, "CsrBlob":{ "type":"blob", "max":32768, diff --git a/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/waiters-2.json b/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/waiters-2.json index 6da2171132e..1d48140dbe4 100644 --- a/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/waiters-2.json +++ b/contrib/python/botocore/py3/botocore/data/acm-pca/2017-08-22/waiters-2.json @@ -1,76 +1,64 @@ { - "version": 2, - "waiters": { - "CertificateAuthorityCSRCreated": { - "description": "Wait until a Certificate Authority CSR is created", - "operation": "GetCertificateAuthorityCsr", - "delay": 3, - "maxAttempts": 60, - "acceptors": [ - { - "state": "success", - "matcher": "status", - "expected": 200 - }, - { - "state": "retry", - "matcher": "error", - "expected": "RequestInProgressException" - }, - { - "state": "failure", - "matcher": "error", - "expected": "AccessDeniedException" - } - ] - }, - "CertificateIssued": { - "description": "Wait until a certificate is issued", - "operation": "GetCertificate", - "delay": 1, - "maxAttempts": 60, - "acceptors": [ - { - "state": "success", - "matcher": "status", - "expected": 200 - }, - { - "state": "retry", - "matcher": "error", - "expected": "RequestInProgressException" - }, - { - "state": "failure", - "matcher": "error", - "expected": "AccessDeniedException" - } - ] - }, - "AuditReportCreated": { - "description": "Wait until a Audit Report is created", - "operation": "DescribeCertificateAuthorityAuditReport", - "delay": 3, - "maxAttempts": 60, - "acceptors": [ - { - "state": "success", - "matcher": "path", - "argument": "AuditReportStatus", - "expected": "SUCCESS" - }, - { - "state": "failure", - "matcher": "path", - "argument": "AuditReportStatus", - "expected": "FAILED" - }, - { - "state": "failure", - "matcher": "error", - "expected": "AccessDeniedException" - } - ] - } + "version" : 2, + "waiters" : { + "AuditReportCreated" : { + "description" : "Wait until a Audit Report is created", + "delay" : 3, + "maxAttempts" : 60, + "operation" : "DescribeCertificateAuthorityAuditReport", + "acceptors" : [ { + "matcher" : "path", + "argument" : "AuditReportStatus", + "state" : "success", + "expected" : "SUCCESS" + }, { + "matcher" : "path", + "argument" : "AuditReportStatus", + "state" : "failure", + "expected" : "FAILED" + }, { + "matcher" : "error", + "state" : "failure", + "expected" : "AccessDeniedException" + } ] + }, + "CertificateAuthorityCSRCreated" : { + "description" : "Wait until a Certificate Authority CSR is created", + "delay" : 3, + "maxAttempts" : 60, + "operation" : "GetCertificateAuthorityCsr", + "acceptors" : [ { + "matcher" : "error", + "state" : "success", + "expected" : false + }, { + "matcher" : "error", + "state" : "retry", + "expected" : "RequestInProgressException" + }, { + "matcher" : "error", + "state" : "failure", + "expected" : "AccessDeniedException" + } ] + }, + "CertificateIssued" : { + "description" : "Wait until a certificate is issued", + "delay" : 1, + "maxAttempts" : 60, + "operation" : "GetCertificate", + "acceptors" : [ { + "matcher" : "error", + "state" : "success", + "expected" : false + }, { + "matcher" : "error", + "state" : "retry", + "expected" : "RequestInProgressException" + }, { + "matcher" : "error", + "state" : "failure", + "expected" : "AccessDeniedException" + } ] } -} + } +}
\ No newline at end of file diff --git a/contrib/python/botocore/py3/botocore/data/amp/2020-08-01/service-2.json b/contrib/python/botocore/py3/botocore/data/amp/2020-08-01/service-2.json index 2ba81375e79..beb8e97f39c 100644 --- a/contrib/python/botocore/py3/botocore/data/amp/2020-08-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/amp/2020-08-01/service-2.json @@ -800,6 +800,10 @@ "shape":"Destination", "documentation":"<p>The Amazon Managed Service for Prometheus workspace to send metrics to.</p>" }, + "roleConfiguration":{ + "shape":"RoleConfiguration", + "documentation":"<p>The scraper role configuration for the workspace.</p>" + }, "scrapeConfiguration":{ "shape":"ScrapeConfiguration", "documentation":"<p>The configuration file to use in the new scraper. For more information, see <a href=\"https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration\">Scraper configuration</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</p>" @@ -1223,7 +1227,8 @@ }, "IamRoleArn":{ "type":"string", - "documentation":"<p>An ARN identifying an IAM role used by the scraper.</p>" + "documentation":"<p>An ARN identifying an IAM role used by the scraper.</p>", + "pattern":"^arn:aws[-a-z]*:iam::[0-9]{12}:role/.+$" }, "IdempotencyToken":{ "type":"string", @@ -1262,7 +1267,7 @@ "documentation":"<p>A KMS Key ARN.</p>", "max":2048, "min":20, - "pattern":"^arn:aws:kms:[a-z0-9\\-]+:\\d+:key/[a-f0-9\\-]+$" + "pattern":"^arn:aws[-a-z]*:kms:[-a-z0-9]+:[0-9]{12}:key/[-a-f0-9]+$" }, "ListRuleGroupsNamespacesRequest":{ "type":"structure", @@ -1428,7 +1433,7 @@ }, "LogGroupArn":{ "type":"string", - "pattern":"^arn:aws[a-z0-9-]*:logs:[a-z0-9-]+:\\d{12}:log-group:[A-Za-z0-9\\.\\-\\_\\#/]{1,512}\\:\\*$" + "pattern":"^arn:aws[-a-z]*:logs:[-a-z0-9]+:[0-9]{12}:log-group:[A-Za-z0-9\\.\\-\\_\\#/]{1,512}\\:\\*$" }, "LoggingConfigurationMetadata":{ "type":"structure", @@ -1619,6 +1624,20 @@ }, "exception":true }, + "RoleConfiguration":{ + "type":"structure", + "members":{ + "sourceRoleArn":{ + "shape":"IamRoleArn", + "documentation":"<p>A ARN identifying the source role configuration.</p>" + }, + "targetRoleArn":{ + "shape":"IamRoleArn", + "documentation":"<p>A ARN identifying the target role configuration.</p>" + } + }, + "documentation":"<p>To configure roles that allows users to write to an Amazon Managed Service for Prometheus workspace in a different account.</p>" + }, "RuleGroupsNamespaceArn":{ "type":"string", "documentation":"<p>An ARN identifying a rule groups namespace.</p>" @@ -1805,6 +1824,7 @@ "shape":"IamRoleArn", "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.</p> <p>For example, <code>arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example</code>.</p>" }, + "roleConfiguration":{"shape":"RoleConfiguration"}, "scrapeConfiguration":{ "shape":"ScrapeConfiguration", "documentation":"<p>The configuration in use by the scraper.</p>" @@ -1914,6 +1934,7 @@ "shape":"IamRoleArn", "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.</p>" }, + "roleConfiguration":{"shape":"RoleConfiguration"}, "scraperId":{ "shape":"ScraperId", "documentation":"<p>The ID of the scraper.</p>" @@ -2191,6 +2212,10 @@ "shape":"Destination", "documentation":"<p>The new Amazon Managed Service for Prometheus workspace to send metrics to.</p>" }, + "roleConfiguration":{ + "shape":"RoleConfiguration", + "documentation":"<p>The scraper role configuration for the workspace.</p>" + }, "scrapeConfiguration":{ "shape":"ScrapeConfiguration", "documentation":"<p>Contains the base-64 encoded YAML configuration for the scraper.</p> <note> <p>For more information about configuring a scraper, see <a href=\"https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html\">Using an Amazon Web Services managed collector</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</p> </note>" diff --git a/contrib/python/botocore/py3/botocore/data/amplify/2017-07-25/service-2.json b/contrib/python/botocore/py3/botocore/data/amplify/2017-07-25/service-2.json index f9ae5dd025b..4b546afdb8c 100644 --- a/contrib/python/botocore/py3/botocore/data/amplify/2017-07-25/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/amplify/2017-07-25/service-2.json @@ -689,9 +689,13 @@ "shape":"UpdateTime", "documentation":"<p>A timestamp of when Amplify updated the application.</p>" }, + "computeRoleArn":{ + "shape":"ComputeRoleArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>" + }, "iamServiceRoleArn":{ "shape":"ServiceRoleArn", - "documentation":"<p>The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app. </p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.</p>" }, "environmentVariables":{ "shape":"EnvironmentVariables", @@ -1098,7 +1102,11 @@ "shape":"BackendEnvironmentArn", "documentation":"<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p> <p>This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>" }, - "backend":{"shape":"Backend"} + "backend":{"shape":"Backend"}, + "computeRoleArn":{ + "shape":"ComputeRoleArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>" + } }, "documentation":"<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>" }, @@ -1207,6 +1215,12 @@ "pattern":"(?s).*" }, "CommitTime":{"type":"timestamp"}, + "ComputeRoleArn":{ + "type":"string", + "max":1000, + "min":0, + "pattern":"(?s).*" + }, "Condition":{ "type":"string", "max":2048, @@ -1234,9 +1248,13 @@ "shape":"Platform", "documentation":"<p>The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to <code>WEB_DYNAMIC</code>.</p> <p>If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to <code>WEB_COMPUTE</code> and set the artifacts <code>baseDirectory</code> to <code>.next</code> in the application's build settings. For an example of the build specification settings, see <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14\">Amplify build settings for a Next.js 14 SSG application</a> in the <i>Amplify Hosting User Guide</i>.</p>" }, + "computeRoleArn":{ + "shape":"ComputeRoleArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>" + }, "iamServiceRoleArn":{ "shape":"ServiceRoleArn", - "documentation":"<p>The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.</p>" }, "oauthToken":{ "shape":"OauthToken", @@ -1431,6 +1449,10 @@ "backend":{ "shape":"Backend", "documentation":"<p>The backend for a <code>Branch</code> of an Amplify app. Use for a backend created from an CloudFormation stack.</p> <p>This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>" + }, + "computeRoleArn":{ + "shape":"ComputeRoleArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>" } }, "documentation":"<p> The request structure for the create branch request. </p>" @@ -3271,9 +3293,13 @@ "shape":"Platform", "documentation":"<p>The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to <code>WEB_DYNAMIC</code>.</p> <p>If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to <code>WEB_COMPUTE</code>.</p>" }, + "computeRoleArn":{ + "shape":"ComputeRoleArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>" + }, "iamServiceRoleArn":{ "shape":"ServiceRoleArn", - "documentation":"<p>The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.</p>" }, "environmentVariables":{ "shape":"EnvironmentVariables", @@ -3431,6 +3457,10 @@ "backend":{ "shape":"Backend", "documentation":"<p>The backend for a <code>Branch</code> of an Amplify app. Use for a backend created from an CloudFormation stack.</p> <p>This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>" + }, + "computeRoleArn":{ + "shape":"ComputeRoleArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see <a href=\"https://docs.aws.amazon.com/latest/userguide/amplify-SSR-compute-role.html\">Adding an SSR Compute role</a> in the <i>Amplify User Guide</i>.</p>" } }, "documentation":"<p>The request structure for the update branch request. </p>" diff --git a/contrib/python/botocore/py3/botocore/data/apigateway/2015-07-09/service-2.json b/contrib/python/botocore/py3/botocore/data/apigateway/2015-07-09/service-2.json index 2d551032fd4..2602d85be71 100644 --- a/contrib/python/botocore/py3/botocore/data/apigateway/2015-07-09/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/apigateway/2015-07-09/service-2.json @@ -2626,7 +2626,7 @@ }, "domainNameId":{ "shape":"String", - "documentation":"<p>The identifier for the domain name resource. Supported only for private custom domain names.</p>", + "documentation":"<p>The identifier for the domain name resource. Required for private custom domain names.</p>", "location":"querystring", "locationName":"domainNameId" }, @@ -4474,7 +4474,7 @@ }, "domainNameId":{ "shape":"String", - "documentation":"<p> The identifier for the domain name resource. Supported only for private custom domain names. </p>", + "documentation":"<p> The identifier for the domain name resource. Required for private custom domain names. </p>", "location":"querystring", "locationName":"domainNameId" } diff --git a/contrib/python/botocore/py3/botocore/data/apigatewayv2/2018-11-29/endpoint-rule-set-1.json b/contrib/python/botocore/py3/botocore/data/apigatewayv2/2018-11-29/endpoint-rule-set-1.json index 61804152356..c8acc7bd13a 100644 --- a/contrib/python/botocore/py3/botocore/data/apigatewayv2/2018-11-29/endpoint-rule-set-1.json +++ b/contrib/python/botocore/py3/botocore/data/apigatewayv2/2018-11-29/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,11 +212,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -231,14 +227,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,7 +250,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -272,7 +269,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -283,14 +279,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -301,9 +299,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/contrib/python/botocore/py3/botocore/data/apigatewayv2/2018-11-29/service-2.json b/contrib/python/botocore/py3/botocore/data/apigatewayv2/2018-11-29/service-2.json index 367f45df1af..5cebba7fb77 100644 --- a/contrib/python/botocore/py3/botocore/data/apigatewayv2/2018-11-29/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/apigatewayv2/2018-11-29/service-2.json @@ -1,8818 +1,9427 @@ { - "metadata" : { - "apiVersion" : "2018-11-29", - "endpointPrefix" : "apigateway", - "signingName" : "apigateway", - "serviceFullName" : "AmazonApiGatewayV2", - "serviceId" : "ApiGatewayV2", - "protocol" : "rest-json", - "jsonVersion" : "1.1", - "uid" : "apigatewayv2-2018-11-29", - "signatureVersion" : "v4" + "metadata": { + "apiVersion": "2018-11-29", + "endpointPrefix": "apigateway", + "signingName": "apigateway", + "serviceFullName": "AmazonApiGatewayV2", + "serviceId": "ApiGatewayV2", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "apigatewayv2-2018-11-29", + "signatureVersion": "v4", + "auth": [ + "aws.auth#sigv4" + ] }, - "operations" : { - "CreateApi" : { - "name" : "CreateApi", - "http" : { - "method" : "POST", - "requestUri" : "/v2/apis", - "responseCode" : 201 + "operations": { + "CreateApi": { + "name": "CreateApi", + "http": { + "method": "POST", + "requestUri": "/v2/apis", + "responseCode": 201 }, - "input" : { - "shape" : "CreateApiRequest" + "input": { + "shape": "CreateApiRequest" }, - "output" : { - "shape" : "CreateApiResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateApiResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates an Api resource.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates an Api resource.</p>" }, - "CreateApiMapping" : { - "name" : "CreateApiMapping", - "http" : { - "method" : "POST", - "requestUri" : "/v2/domainnames/{domainName}/apimappings", - "responseCode" : 201 + "CreateApiMapping": { + "name": "CreateApiMapping", + "http": { + "method": "POST", + "requestUri": "/v2/domainnames/{domainName}/apimappings", + "responseCode": 201 }, - "input" : { - "shape" : "CreateApiMappingRequest" + "input": { + "shape": "CreateApiMappingRequest" }, - "output" : { - "shape" : "CreateApiMappingResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateApiMappingResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates an API mapping.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates an API mapping.</p>" }, - "CreateAuthorizer" : { - "name" : "CreateAuthorizer", - "http" : { - "method" : "POST", - "requestUri" : "/v2/apis/{apiId}/authorizers", - "responseCode" : 201 + "CreateAuthorizer": { + "name": "CreateAuthorizer", + "http": { + "method": "POST", + "requestUri": "/v2/apis/{apiId}/authorizers", + "responseCode": 201 }, - "input" : { - "shape" : "CreateAuthorizerRequest" + "input": { + "shape": "CreateAuthorizerRequest" }, - "output" : { - "shape" : "CreateAuthorizerResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateAuthorizerResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates an Authorizer for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates an Authorizer for an API.</p>" }, - "CreateDeployment" : { - "name" : "CreateDeployment", - "http" : { - "method" : "POST", - "requestUri" : "/v2/apis/{apiId}/deployments", - "responseCode" : 201 + "CreateDeployment": { + "name": "CreateDeployment", + "http": { + "method": "POST", + "requestUri": "/v2/apis/{apiId}/deployments", + "responseCode": 201 }, - "input" : { - "shape" : "CreateDeploymentRequest" + "input": { + "shape": "CreateDeploymentRequest" }, - "output" : { - "shape" : "CreateDeploymentResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateDeploymentResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates a Deployment for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates a Deployment for an API.</p>" }, - "CreateDomainName" : { - "name" : "CreateDomainName", - "http" : { - "method" : "POST", - "requestUri" : "/v2/domainnames", - "responseCode" : 201 + "CreateDomainName": { + "name": "CreateDomainName", + "http": { + "method": "POST", + "requestUri": "/v2/domainnames", + "responseCode": 201 }, - "input" : { - "shape" : "CreateDomainNameRequest" + "input": { + "shape": "CreateDomainNameRequest" }, - "output" : { - "shape" : "CreateDomainNameResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateDomainNameResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - }, { - "shape" : "AccessDeniedException", - "documentation" : "<p>403 response</p>" - } ], - "documentation" : "<p>Creates a domain name.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + }, + { + "shape": "AccessDeniedException", + "documentation": "<p>403 response</p>" + } + ], + "documentation": "<p>Creates a domain name.</p>" }, - "CreateIntegration" : { - "name" : "CreateIntegration", - "http" : { - "method" : "POST", - "requestUri" : "/v2/apis/{apiId}/integrations", - "responseCode" : 201 + "CreateIntegration": { + "name": "CreateIntegration", + "http": { + "method": "POST", + "requestUri": "/v2/apis/{apiId}/integrations", + "responseCode": 201 }, - "input" : { - "shape" : "CreateIntegrationRequest" + "input": { + "shape": "CreateIntegrationRequest" }, - "output" : { - "shape" : "CreateIntegrationResult", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateIntegrationResult", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates an Integration.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates an Integration.</p>" }, - "CreateIntegrationResponse" : { - "name" : "CreateIntegrationResponse", - "http" : { - "method" : "POST", - "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", - "responseCode" : 201 + "CreateIntegrationResponse": { + "name": "CreateIntegrationResponse", + "http": { + "method": "POST", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", + "responseCode": 201 }, - "input" : { - "shape" : "CreateIntegrationResponseRequest" + "input": { + "shape": "CreateIntegrationResponseRequest" }, - "output" : { - "shape" : "CreateIntegrationResponseResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateIntegrationResponseResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates an IntegrationResponses.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates an IntegrationResponses.</p>" }, - "CreateModel" : { - "name" : "CreateModel", - "http" : { - "method" : "POST", - "requestUri" : "/v2/apis/{apiId}/models", - "responseCode" : 201 + "CreateModel": { + "name": "CreateModel", + "http": { + "method": "POST", + "requestUri": "/v2/apis/{apiId}/models", + "responseCode": 201 }, - "input" : { - "shape" : "CreateModelRequest" + "input": { + "shape": "CreateModelRequest" }, - "output" : { - "shape" : "CreateModelResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateModelResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates a Model for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates a Model for an API.</p>" }, - "CreateRoute" : { - "name" : "CreateRoute", - "http" : { - "method" : "POST", - "requestUri" : "/v2/apis/{apiId}/routes", - "responseCode" : 201 + "CreateRoute": { + "name": "CreateRoute", + "http": { + "method": "POST", + "requestUri": "/v2/apis/{apiId}/routes", + "responseCode": 201 }, - "input" : { - "shape" : "CreateRouteRequest" + "input": { + "shape": "CreateRouteRequest" }, - "output" : { - "shape" : "CreateRouteResult", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateRouteResult", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates a Route for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates a Route for an API.</p>" }, - "CreateRouteResponse" : { - "name" : "CreateRouteResponse", - "http" : { - "method" : "POST", - "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses", - "responseCode" : 201 + "CreateRouteResponse": { + "name": "CreateRouteResponse", + "http": { + "method": "POST", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses", + "responseCode": 201 }, - "input" : { - "shape" : "CreateRouteResponseRequest" + "input": { + "shape": "CreateRouteResponseRequest" }, - "output" : { - "shape" : "CreateRouteResponseResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateRouteResponseResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates a RouteResponse for a Route.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates a RouteResponse for a Route.</p>" }, - "CreateStage" : { - "name" : "CreateStage", - "http" : { - "method" : "POST", - "requestUri" : "/v2/apis/{apiId}/stages", - "responseCode" : 201 + "CreateStage": { + "name": "CreateStage", + "http": { + "method": "POST", + "requestUri": "/v2/apis/{apiId}/stages", + "responseCode": 201 }, - "input" : { - "shape" : "CreateStageRequest" + "input": { + "shape": "CreateStageRequest" }, - "output" : { - "shape" : "CreateStageResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateStageResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates a Stage for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates a Stage for an API.</p>" }, - "CreateVpcLink" : { - "name" : "CreateVpcLink", - "http" : { - "method" : "POST", - "requestUri" : "/v2/vpclinks", - "responseCode" : 201 + "CreateVpcLink": { + "name": "CreateVpcLink", + "http": { + "method": "POST", + "requestUri": "/v2/vpclinks", + "responseCode": 201 }, - "input" : { - "shape" : "CreateVpcLinkRequest" + "input": { + "shape": "CreateVpcLinkRequest" }, - "output" : { - "shape" : "CreateVpcLinkResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "CreateVpcLinkResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Creates a VPC link.</p>" + "errors": [ + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Creates a VPC link.</p>" }, - "DeleteAccessLogSettings" : { - "name" : "DeleteAccessLogSettings", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/stages/{stageName}/accesslogsettings", - "responseCode" : 204 + "DeleteAccessLogSettings": { + "name": "DeleteAccessLogSettings", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/stages/{stageName}/accesslogsettings", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteAccessLogSettingsRequest" + "input": { + "shape": "DeleteAccessLogSettingsRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.</p>" }, - "DeleteApi" : { - "name" : "DeleteApi", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}", - "responseCode" : 204 + "DeleteApi": { + "name": "DeleteApi", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteApiRequest" + "input": { + "shape": "DeleteApiRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes an Api resource.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes an Api resource.</p>" }, - "DeleteApiMapping" : { - "name" : "DeleteApiMapping", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", - "responseCode" : 204 + "DeleteApiMapping": { + "name": "DeleteApiMapping", + "http": { + "method": "DELETE", + "requestUri": "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteApiMappingRequest" + "input": { + "shape": "DeleteApiMappingRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Deletes an API mapping.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Deletes an API mapping.</p>" }, - "DeleteAuthorizer" : { - "name" : "DeleteAuthorizer", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}", - "responseCode" : 204 + "DeleteAuthorizer": { + "name": "DeleteAuthorizer", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteAuthorizerRequest" + "input": { + "shape": "DeleteAuthorizerRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes an Authorizer.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes an Authorizer.</p>" }, - "DeleteCorsConfiguration" : { - "name" : "DeleteCorsConfiguration", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/cors", - "responseCode" : 204 + "DeleteCorsConfiguration": { + "name": "DeleteCorsConfiguration", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/cors", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteCorsConfigurationRequest" + "input": { + "shape": "DeleteCorsConfigurationRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes a CORS configuration.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes a CORS configuration.</p>" }, - "DeleteDeployment" : { - "name" : "DeleteDeployment", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}", - "responseCode" : 204 + "DeleteDeployment": { + "name": "DeleteDeployment", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteDeploymentRequest" + "input": { + "shape": "DeleteDeploymentRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes a Deployment.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes a Deployment.</p>" }, - "DeleteDomainName" : { - "name" : "DeleteDomainName", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/domainnames/{domainName}", - "responseCode" : 204 + "DeleteDomainName": { + "name": "DeleteDomainName", + "http": { + "method": "DELETE", + "requestUri": "/v2/domainnames/{domainName}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteDomainNameRequest" + "input": { + "shape": "DeleteDomainNameRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes a domain name.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes a domain name.</p>" }, - "DeleteIntegration" : { - "name" : "DeleteIntegration", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}", - "responseCode" : 204 + "DeleteIntegration": { + "name": "DeleteIntegration", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteIntegrationRequest" + "input": { + "shape": "DeleteIntegrationRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes an Integration.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes an Integration.</p>" }, - "DeleteIntegrationResponse" : { - "name" : "DeleteIntegrationResponse", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", - "responseCode" : 204 + "DeleteIntegrationResponse": { + "name": "DeleteIntegrationResponse", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteIntegrationResponseRequest" + "input": { + "shape": "DeleteIntegrationResponseRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes an IntegrationResponses.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes an IntegrationResponses.</p>" }, - "DeleteModel" : { - "name" : "DeleteModel", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/models/{modelId}", - "responseCode" : 204 + "DeleteModel": { + "name": "DeleteModel", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/models/{modelId}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteModelRequest" + "input": { + "shape": "DeleteModelRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes a Model.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes a Model.</p>" }, - "DeleteRoute" : { - "name" : "DeleteRoute", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/routes/{routeId}", - "responseCode" : 204 + "DeleteRoute": { + "name": "DeleteRoute", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteRouteRequest" + "input": { + "shape": "DeleteRouteRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes a Route.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes a Route.</p>" }, - "DeleteRouteRequestParameter" : { - "name" : "DeleteRouteRequestParameter", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/requestparameters/{requestParameterKey}", - "responseCode" : 204 + "DeleteRouteRequestParameter": { + "name": "DeleteRouteRequestParameter", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/requestparameters/{requestParameterKey}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteRouteRequestParameterRequest" + "input": { + "shape": "DeleteRouteRequestParameterRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes a route request parameter. Supported only for WebSocket APIs.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes a route request parameter. Supported only for WebSocket APIs.</p>" }, - "DeleteRouteResponse" : { - "name" : "DeleteRouteResponse", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", - "responseCode" : 204 + "DeleteRouteResponse": { + "name": "DeleteRouteResponse", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteRouteResponseRequest" + "input": { + "shape": "DeleteRouteResponseRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes a RouteResponse.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes a RouteResponse.</p>" }, - "DeleteRouteSettings" : { - "name" : "DeleteRouteSettings", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/stages/{stageName}/routesettings/{routeKey}", - "responseCode" : 204 + "DeleteRouteSettings": { + "name": "DeleteRouteSettings", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/stages/{stageName}/routesettings/{routeKey}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteRouteSettingsRequest" + "input": { + "shape": "DeleteRouteSettingsRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes the RouteSettings for a stage.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes the RouteSettings for a stage.</p>" }, - "DeleteStage" : { - "name" : "DeleteStage", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/stages/{stageName}", - "responseCode" : 204 + "DeleteStage": { + "name": "DeleteStage", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/stages/{stageName}", + "responseCode": 204 }, - "input" : { - "shape" : "DeleteStageRequest" + "input": { + "shape": "DeleteStageRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes a Stage.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes a Stage.</p>" }, - "DeleteVpcLink" : { - "name" : "DeleteVpcLink", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/vpclinks/{vpcLinkId}", - "responseCode" : 202 + "DeleteVpcLink": { + "name": "DeleteVpcLink", + "http": { + "method": "DELETE", + "requestUri": "/v2/vpclinks/{vpcLinkId}", + "responseCode": 202 }, - "input" : { - "shape" : "DeleteVpcLinkRequest" + "input": { + "shape": "DeleteVpcLinkRequest" }, - "output" : { - "shape" : "DeleteVpcLinkResponse", - "documentation" : "<p>202 response</p>" + "output": { + "shape": "DeleteVpcLinkResponse", + "documentation": "<p>202 response</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Deletes a VPC link.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Deletes a VPC link.</p>" }, - "ExportApi" : { - "name" : "ExportApi", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/exports/{specification}", - "responseCode" : 200 + "ExportApi": { + "name": "ExportApi", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/exports/{specification}", + "responseCode": 200 }, - "input" : { - "shape" : "ExportApiRequest" + "input": { + "shape": "ExportApiRequest" }, - "output" : { - "shape" : "ExportApiResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "ExportApiResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ] + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ] }, - "ResetAuthorizersCache" : { - "name" : "ResetAuthorizersCache", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/apis/{apiId}/stages/{stageName}/cache/authorizers", - "responseCode" : 204 + "ResetAuthorizersCache": { + "name": "ResetAuthorizersCache", + "http": { + "method": "DELETE", + "requestUri": "/v2/apis/{apiId}/stages/{stageName}/cache/authorizers", + "responseCode": 204 }, - "input" : { - "shape" : "ResetAuthorizersCacheRequest" + "input": { + "shape": "ResetAuthorizersCacheRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.</p>" }, - "GetApi" : { - "name" : "GetApi", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}", - "responseCode" : 200 + "GetApi": { + "name": "GetApi", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}", + "responseCode": 200 }, - "input" : { - "shape" : "GetApiRequest" + "input": { + "shape": "GetApiRequest" }, - "output" : { - "shape" : "GetApiResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetApiResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets an Api resource.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets an Api resource.</p>" }, - "GetApiMapping" : { - "name" : "GetApiMapping", - "http" : { - "method" : "GET", - "requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", - "responseCode" : 200 + "GetApiMapping": { + "name": "GetApiMapping", + "http": { + "method": "GET", + "requestUri": "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode": 200 }, - "input" : { - "shape" : "GetApiMappingRequest" + "input": { + "shape": "GetApiMappingRequest" }, - "output" : { - "shape" : "GetApiMappingResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetApiMappingResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets an API mapping.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets an API mapping.</p>" }, - "GetApiMappings" : { - "name" : "GetApiMappings", - "http" : { - "method" : "GET", - "requestUri" : "/v2/domainnames/{domainName}/apimappings", - "responseCode" : 200 + "GetApiMappings": { + "name": "GetApiMappings", + "http": { + "method": "GET", + "requestUri": "/v2/domainnames/{domainName}/apimappings", + "responseCode": 200 }, - "input" : { - "shape" : "GetApiMappingsRequest" + "input": { + "shape": "GetApiMappingsRequest" }, - "output" : { - "shape" : "GetApiMappingsResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetApiMappingsResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets API mappings.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets API mappings.</p>" }, - "GetApis" : { - "name" : "GetApis", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis", - "responseCode" : 200 + "GetApis": { + "name": "GetApis", + "http": { + "method": "GET", + "requestUri": "/v2/apis", + "responseCode": 200 }, - "input" : { - "shape" : "GetApisRequest" + "input": { + "shape": "GetApisRequest" }, - "output" : { - "shape" : "GetApisResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetApisResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets a collection of Api resources.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets a collection of Api resources.</p>" }, - "GetAuthorizer" : { - "name" : "GetAuthorizer", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}", - "responseCode" : 200 + "GetAuthorizer": { + "name": "GetAuthorizer", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode": 200 }, - "input" : { - "shape" : "GetAuthorizerRequest" + "input": { + "shape": "GetAuthorizerRequest" }, - "output" : { - "shape" : "GetAuthorizerResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetAuthorizerResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets an Authorizer.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets an Authorizer.</p>" }, - "GetAuthorizers" : { - "name" : "GetAuthorizers", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/authorizers", - "responseCode" : 200 + "GetAuthorizers": { + "name": "GetAuthorizers", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/authorizers", + "responseCode": 200 }, - "input" : { - "shape" : "GetAuthorizersRequest" + "input": { + "shape": "GetAuthorizersRequest" }, - "output" : { - "shape" : "GetAuthorizersResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetAuthorizersResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets the Authorizers for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets the Authorizers for an API.</p>" }, - "GetDeployment" : { - "name" : "GetDeployment", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}", - "responseCode" : 200 + "GetDeployment": { + "name": "GetDeployment", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode": 200 }, - "input" : { - "shape" : "GetDeploymentRequest" + "input": { + "shape": "GetDeploymentRequest" }, - "output" : { - "shape" : "GetDeploymentResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetDeploymentResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets a Deployment.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets a Deployment.</p>" }, - "GetDeployments" : { - "name" : "GetDeployments", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/deployments", - "responseCode" : 200 + "GetDeployments": { + "name": "GetDeployments", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/deployments", + "responseCode": 200 }, - "input" : { - "shape" : "GetDeploymentsRequest" + "input": { + "shape": "GetDeploymentsRequest" }, - "output" : { - "shape" : "GetDeploymentsResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetDeploymentsResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets the Deployments for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets the Deployments for an API.</p>" }, - "GetDomainName" : { - "name" : "GetDomainName", - "http" : { - "method" : "GET", - "requestUri" : "/v2/domainnames/{domainName}", - "responseCode" : 200 + "GetDomainName": { + "name": "GetDomainName", + "http": { + "method": "GET", + "requestUri": "/v2/domainnames/{domainName}", + "responseCode": 200 }, - "input" : { - "shape" : "GetDomainNameRequest" + "input": { + "shape": "GetDomainNameRequest" }, - "output" : { - "shape" : "GetDomainNameResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetDomainNameResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets a domain name.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets a domain name.</p>" }, - "GetDomainNames" : { - "name" : "GetDomainNames", - "http" : { - "method" : "GET", - "requestUri" : "/v2/domainnames", - "responseCode" : 200 + "GetDomainNames": { + "name": "GetDomainNames", + "http": { + "method": "GET", + "requestUri": "/v2/domainnames", + "responseCode": 200 }, - "input" : { - "shape" : "GetDomainNamesRequest" + "input": { + "shape": "GetDomainNamesRequest" }, - "output" : { - "shape" : "GetDomainNamesResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetDomainNamesResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets the domain names for an AWS account.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets the domain names for an AWS account.</p>" }, - "GetIntegration" : { - "name" : "GetIntegration", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}", - "responseCode" : 200 + "GetIntegration": { + "name": "GetIntegration", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode": 200 }, - "input" : { - "shape" : "GetIntegrationRequest" + "input": { + "shape": "GetIntegrationRequest" }, - "output" : { - "shape" : "GetIntegrationResult", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetIntegrationResult", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets an Integration.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets an Integration.</p>" }, - "GetIntegrationResponse" : { - "name" : "GetIntegrationResponse", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", - "responseCode" : 200 + "GetIntegrationResponse": { + "name": "GetIntegrationResponse", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode": 200 }, - "input" : { - "shape" : "GetIntegrationResponseRequest" + "input": { + "shape": "GetIntegrationResponseRequest" }, - "output" : { - "shape" : "GetIntegrationResponseResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetIntegrationResponseResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets an IntegrationResponses.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets an IntegrationResponses.</p>" }, - "GetIntegrationResponses" : { - "name" : "GetIntegrationResponses", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", - "responseCode" : 200 + "GetIntegrationResponses": { + "name": "GetIntegrationResponses", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", + "responseCode": 200 }, - "input" : { - "shape" : "GetIntegrationResponsesRequest" + "input": { + "shape": "GetIntegrationResponsesRequest" }, - "output" : { - "shape" : "GetIntegrationResponsesResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetIntegrationResponsesResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets the IntegrationResponses for an Integration.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets the IntegrationResponses for an Integration.</p>" }, - "GetIntegrations" : { - "name" : "GetIntegrations", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/integrations", - "responseCode" : 200 + "GetIntegrations": { + "name": "GetIntegrations", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/integrations", + "responseCode": 200 }, - "input" : { - "shape" : "GetIntegrationsRequest" + "input": { + "shape": "GetIntegrationsRequest" }, - "output" : { - "shape" : "GetIntegrationsResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetIntegrationsResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets the Integrations for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets the Integrations for an API.</p>" }, - "GetModel" : { - "name" : "GetModel", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/models/{modelId}", - "responseCode" : 200 + "GetModel": { + "name": "GetModel", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/models/{modelId}", + "responseCode": 200 }, - "input" : { - "shape" : "GetModelRequest" + "input": { + "shape": "GetModelRequest" }, - "output" : { - "shape" : "GetModelResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetModelResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets a Model.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets a Model.</p>" }, - "GetModelTemplate" : { - "name" : "GetModelTemplate", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/models/{modelId}/template", - "responseCode" : 200 + "GetModelTemplate": { + "name": "GetModelTemplate", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/models/{modelId}/template", + "responseCode": 200 }, - "input" : { - "shape" : "GetModelTemplateRequest" + "input": { + "shape": "GetModelTemplateRequest" }, - "output" : { - "shape" : "GetModelTemplateResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetModelTemplateResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets a model template.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets a model template.</p>" }, - "GetModels" : { - "name" : "GetModels", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/models", - "responseCode" : 200 + "GetModels": { + "name": "GetModels", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/models", + "responseCode": 200 }, - "input" : { - "shape" : "GetModelsRequest" + "input": { + "shape": "GetModelsRequest" }, - "output" : { - "shape" : "GetModelsResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetModelsResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets the Models for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets the Models for an API.</p>" }, - "GetRoute" : { - "name" : "GetRoute", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/routes/{routeId}", - "responseCode" : 200 + "GetRoute": { + "name": "GetRoute", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}", + "responseCode": 200 }, - "input" : { - "shape" : "GetRouteRequest" + "input": { + "shape": "GetRouteRequest" }, - "output" : { - "shape" : "GetRouteResult", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetRouteResult", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets a Route.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets a Route.</p>" }, - "GetRouteResponse" : { - "name" : "GetRouteResponse", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", - "responseCode" : 200 + "GetRouteResponse": { + "name": "GetRouteResponse", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode": 200 }, - "input" : { - "shape" : "GetRouteResponseRequest" + "input": { + "shape": "GetRouteResponseRequest" }, - "output" : { - "shape" : "GetRouteResponseResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetRouteResponseResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets a RouteResponse.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets a RouteResponse.</p>" }, - "GetRouteResponses" : { - "name" : "GetRouteResponses", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses", - "responseCode" : 200 + "GetRouteResponses": { + "name": "GetRouteResponses", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses", + "responseCode": 200 }, - "input" : { - "shape" : "GetRouteResponsesRequest" + "input": { + "shape": "GetRouteResponsesRequest" }, - "output" : { - "shape" : "GetRouteResponsesResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetRouteResponsesResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets the RouteResponses for a Route.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets the RouteResponses for a Route.</p>" }, - "GetRoutes" : { - "name" : "GetRoutes", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/routes", - "responseCode" : 200 + "GetRoutes": { + "name": "GetRoutes", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/routes", + "responseCode": 200 }, - "input" : { - "shape" : "GetRoutesRequest" + "input": { + "shape": "GetRoutesRequest" }, - "output" : { - "shape" : "GetRoutesResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetRoutesResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets the Routes for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets the Routes for an API.</p>" }, - "GetStage" : { - "name" : "GetStage", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/stages/{stageName}", - "responseCode" : 200 + "GetStage": { + "name": "GetStage", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/stages/{stageName}", + "responseCode": 200 }, - "input" : { - "shape" : "GetStageRequest" + "input": { + "shape": "GetStageRequest" }, - "output" : { - "shape" : "GetStageResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetStageResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets a Stage.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets a Stage.</p>" }, - "GetStages" : { - "name" : "GetStages", - "http" : { - "method" : "GET", - "requestUri" : "/v2/apis/{apiId}/stages", - "responseCode" : 200 + "GetStages": { + "name": "GetStages", + "http": { + "method": "GET", + "requestUri": "/v2/apis/{apiId}/stages", + "responseCode": 200 }, - "input" : { - "shape" : "GetStagesRequest" + "input": { + "shape": "GetStagesRequest" }, - "output" : { - "shape" : "GetStagesResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetStagesResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Gets the Stages for an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Gets the Stages for an API.</p>" }, - "GetTags" : { - "name" : "GetTags", - "http" : { - "method" : "GET", - "requestUri" : "/v2/tags/{resource-arn}", - "responseCode" : 200 + "GetTags": { + "name": "GetTags", + "http": { + "method": "GET", + "requestUri": "/v2/tags/{resource-arn}", + "responseCode": 200 }, - "input" : { - "shape" : "GetTagsRequest" + "input": { + "shape": "GetTagsRequest" }, - "output" : { - "shape" : "GetTagsResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetTagsResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Gets a collection of Tag resources.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Gets a collection of Tag resources.</p>" }, - "GetVpcLink" : { - "name" : "GetVpcLink", - "http" : { - "method" : "GET", - "requestUri" : "/v2/vpclinks/{vpcLinkId}", - "responseCode" : 200 + "GetVpcLink": { + "name": "GetVpcLink", + "http": { + "method": "GET", + "requestUri": "/v2/vpclinks/{vpcLinkId}", + "responseCode": 200 }, - "input" : { - "shape" : "GetVpcLinkRequest" + "input": { + "shape": "GetVpcLinkRequest" }, - "output" : { - "shape" : "GetVpcLinkResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetVpcLinkResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets a VPC link.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets a VPC link.</p>" }, - "GetVpcLinks" : { - "name" : "GetVpcLinks", - "http" : { - "method" : "GET", - "requestUri" : "/v2/vpclinks", - "responseCode" : 200 + "GetVpcLinks": { + "name": "GetVpcLinks", + "http": { + "method": "GET", + "requestUri": "/v2/vpclinks", + "responseCode": 200 }, - "input" : { - "shape" : "GetVpcLinksRequest" + "input": { + "shape": "GetVpcLinksRequest" }, - "output" : { - "shape" : "GetVpcLinksResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "GetVpcLinksResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - } ], - "documentation" : "<p>Gets a collection of VPC links.</p>" + "errors": [ + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + } + ], + "documentation": "<p>Gets a collection of VPC links.</p>" }, - "ImportApi" : { - "name" : "ImportApi", - "http" : { - "method" : "PUT", - "requestUri" : "/v2/apis", - "responseCode" : 201 + "ImportApi": { + "name": "ImportApi", + "http": { + "method": "PUT", + "requestUri": "/v2/apis", + "responseCode": 201 }, - "input" : { - "shape" : "ImportApiRequest" + "input": { + "shape": "ImportApiRequest" }, - "output" : { - "shape" : "ImportApiResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "ImportApiResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Imports an API.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Imports an API.</p>" }, - "ReimportApi" : { - "name" : "ReimportApi", - "http" : { - "method" : "PUT", - "requestUri" : "/v2/apis/{apiId}", - "responseCode" : 201 + "ReimportApi": { + "name": "ReimportApi", + "http": { + "method": "PUT", + "requestUri": "/v2/apis/{apiId}", + "responseCode": 201 }, - "input" : { - "shape" : "ReimportApiRequest" + "input": { + "shape": "ReimportApiRequest" }, - "output" : { - "shape" : "ReimportApiResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "ReimportApiResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Puts an Api resource.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Puts an Api resource.</p>" }, - "TagResource" : { - "name" : "TagResource", - "http" : { - "method" : "POST", - "requestUri" : "/v2/tags/{resource-arn}", - "responseCode" : 201 + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/v2/tags/{resource-arn}", + "responseCode": 201 }, - "input" : { - "shape" : "TagResourceRequest" + "input": { + "shape": "TagResourceRequest" }, - "output" : { - "shape" : "TagResourceResponse", - "documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>" + "output": { + "shape": "TagResourceResponse", + "documentation": "<p>The request has succeeded and has resulted in the creation of a resource.</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Creates a new Tag resource to represent a tag.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Creates a new Tag resource to represent a tag.</p>" }, - "UntagResource" : { - "name" : "UntagResource", - "http" : { - "method" : "DELETE", - "requestUri" : "/v2/tags/{resource-arn}", - "responseCode" : 204 + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "DELETE", + "requestUri": "/v2/tags/{resource-arn}", + "responseCode": 204 }, - "input" : { - "shape" : "UntagResourceRequest" + "input": { + "shape": "UntagResourceRequest" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Deletes a Tag.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Deletes a Tag.</p>" }, - "UpdateApi" : { - "name" : "UpdateApi", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/apis/{apiId}", - "responseCode" : 200 + "UpdateApi": { + "name": "UpdateApi", + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateApiRequest" + "input": { + "shape": "UpdateApiRequest" }, - "output" : { - "shape" : "UpdateApiResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateApiResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Updates an Api resource.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Updates an Api resource.</p>" }, - "UpdateApiMapping" : { - "name" : "UpdateApiMapping", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", - "responseCode" : 200 + "UpdateApiMapping": { + "name": "UpdateApiMapping", + "http": { + "method": "PATCH", + "requestUri": "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateApiMappingRequest" + "input": { + "shape": "UpdateApiMappingRequest" }, - "output" : { - "shape" : "UpdateApiMappingResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateApiMappingResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>The API mapping.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>The API mapping.</p>" }, - "UpdateAuthorizer" : { - "name" : "UpdateAuthorizer", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}", - "responseCode" : 200 + "UpdateAuthorizer": { + "name": "UpdateAuthorizer", + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateAuthorizerRequest" + "input": { + "shape": "UpdateAuthorizerRequest" }, - "output" : { - "shape" : "UpdateAuthorizerResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateAuthorizerResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Updates an Authorizer.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Updates an Authorizer.</p>" }, - "UpdateDeployment" : { - "name" : "UpdateDeployment", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}", - "responseCode" : 200 + "UpdateDeployment": { + "name": "UpdateDeployment", + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateDeploymentRequest" + "input": { + "shape": "UpdateDeploymentRequest" }, - "output" : { - "shape" : "UpdateDeploymentResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateDeploymentResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Updates a Deployment.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Updates a Deployment.</p>" }, - "UpdateDomainName" : { - "name" : "UpdateDomainName", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/domainnames/{domainName}", - "responseCode" : 200 + "UpdateDomainName": { + "name": "UpdateDomainName", + "http": { + "method": "PATCH", + "requestUri": "/v2/domainnames/{domainName}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateDomainNameRequest" + "input": { + "shape": "UpdateDomainNameRequest" }, - "output" : { - "shape" : "UpdateDomainNameResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateDomainNameResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Updates a domain name.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Updates a domain name.</p>" }, - "UpdateIntegration" : { - "name" : "UpdateIntegration", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}", - "responseCode" : 200 + "UpdateIntegration": { + "name": "UpdateIntegration", + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateIntegrationRequest" + "input": { + "shape": "UpdateIntegrationRequest" }, - "output" : { - "shape" : "UpdateIntegrationResult", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateIntegrationResult", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Updates an Integration.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Updates an Integration.</p>" }, - "UpdateIntegrationResponse" : { - "name" : "UpdateIntegrationResponse", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", - "responseCode" : 200 + "UpdateIntegrationResponse": { + "name": "UpdateIntegrationResponse", + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateIntegrationResponseRequest" + "input": { + "shape": "UpdateIntegrationResponseRequest" }, - "output" : { - "shape" : "UpdateIntegrationResponseResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateIntegrationResponseResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Updates an IntegrationResponses.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Updates an IntegrationResponses.</p>" }, - "UpdateModel" : { - "name" : "UpdateModel", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/apis/{apiId}/models/{modelId}", - "responseCode" : 200 + "UpdateModel": { + "name": "UpdateModel", + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/models/{modelId}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateModelRequest" + "input": { + "shape": "UpdateModelRequest" }, - "output" : { - "shape" : "UpdateModelResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateModelResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Updates a Model.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Updates a Model.</p>" }, - "UpdateRoute" : { - "name" : "UpdateRoute", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/apis/{apiId}/routes/{routeId}", - "responseCode" : 200 + "UpdateRoute": { + "name": "UpdateRoute", + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateRouteRequest" + "input": { + "shape": "UpdateRouteRequest" }, - "output" : { - "shape" : "UpdateRouteResult", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateRouteResult", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Updates a Route.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Updates a Route.</p>" }, - "UpdateRouteResponse" : { - "name" : "UpdateRouteResponse", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", - "responseCode" : 200 + "UpdateRouteResponse": { + "name": "UpdateRouteResponse", + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateRouteResponseRequest" + "input": { + "shape": "UpdateRouteResponseRequest" }, - "output" : { - "shape" : "UpdateRouteResponseResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateRouteResponseResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Updates a RouteResponse.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Updates a RouteResponse.</p>" }, - "UpdateStage" : { - "name" : "UpdateStage", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/apis/{apiId}/stages/{stageName}", - "responseCode" : 200 + "UpdateStage": { + "name": "UpdateStage", + "http": { + "method": "PATCH", + "requestUri": "/v2/apis/{apiId}/stages/{stageName}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateStageRequest" + "input": { + "shape": "UpdateStageRequest" }, - "output" : { - "shape" : "UpdateStageResponse", - "documentation" : "<p>Success</p>" + "output": { + "shape": "UpdateStageResponse", + "documentation": "<p>Success</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - }, { - "shape" : "ConflictException", - "documentation" : "<p>The resource already exists.</p>" - } ], - "documentation" : "<p>Updates a Stage.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + }, + { + "shape": "ConflictException", + "documentation": "<p>The resource already exists.</p>" + } + ], + "documentation": "<p>Updates a Stage.</p>" }, - "UpdateVpcLink" : { - "name" : "UpdateVpcLink", - "http" : { - "method" : "PATCH", - "requestUri" : "/v2/vpclinks/{vpcLinkId}", - "responseCode" : 200 + "UpdateVpcLink": { + "name": "UpdateVpcLink", + "http": { + "method": "PATCH", + "requestUri": "/v2/vpclinks/{vpcLinkId}", + "responseCode": 200 }, - "input" : { - "shape" : "UpdateVpcLinkRequest" + "input": { + "shape": "UpdateVpcLinkRequest" }, - "output" : { - "shape" : "UpdateVpcLinkResponse", - "documentation" : "<p>200 response</p>" + "output": { + "shape": "UpdateVpcLinkResponse", + "documentation": "<p>200 response</p>" }, - "errors" : [ { - "shape" : "NotFoundException", - "documentation" : "<p>The resource specified in the request was not found.</p>" - }, { - "shape" : "TooManyRequestsException", - "documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>" - }, { - "shape" : "BadRequestException", - "documentation" : "<p>One of the parameters in the request is invalid.</p>" - } ], - "documentation" : "<p>Updates a VPC link.</p>" + "errors": [ + { + "shape": "NotFoundException", + "documentation": "<p>The resource specified in the request was not found.</p>" + }, + { + "shape": "TooManyRequestsException", + "documentation": "<p>The client is sending more than the allowed number of requests per unit of time.</p>" + }, + { + "shape": "BadRequestException", + "documentation": "<p>One of the parameters in the request is invalid.</p>" + } + ], + "documentation": "<p>Updates a VPC link.</p>" } }, - "shapes" : { - "AccessDeniedException" : { - "type" : "structure", - "members" : { - "Message" : { - "shape" : "__string", - "locationName" : "message" + "shapes": { + "AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" } }, - "exception" : true, - "error" : { - "httpStatusCode" : 403 + "exception": true, + "error": { + "httpStatusCode": 403 } }, - "AccessLogSettings" : { - "type" : "structure", - "members" : { - "DestinationArn" : { - "shape" : "Arn", - "locationName" : "destinationArn", - "documentation" : "<p>The ARN of the CloudWatch Logs log group to receive access logs.</p>" + "AccessLogSettings": { + "type": "structure", + "members": { + "DestinationArn": { + "shape": "Arn", + "locationName": "destinationArn", + "documentation": "<p>The ARN of the CloudWatch Logs log group to receive access logs.</p>" }, - "Format" : { - "shape" : "StringWithLengthBetween1And1024", - "locationName" : "format", - "documentation" : "<p>A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.</p>" + "Format": { + "shape": "StringWithLengthBetween1And1024", + "locationName": "format", + "documentation": "<p>A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.</p>" } }, - "documentation" : "<p>Settings for logging access in a stage.</p>" + "documentation": "<p>Settings for logging access in a stage.</p>" }, - "Api" : { - "type" : "structure", - "members" : { - "ApiEndpoint" : { - "shape" : "__string", - "locationName" : "apiEndpoint", - "documentation" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" + "Api": { + "type": "structure", + "members": { + "ApiEndpoint": { + "shape": "__string", + "locationName": "apiEndpoint", + "documentation": "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" }, - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" }, - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API ID.</p>" + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API ID.</p>" }, - "ApiKeySelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiKeySelectionExpression", - "documentation" : "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" + "ApiKeySelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiKeySelectionExpression", + "documentation": "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" }, - "CorsConfiguration" : { - "shape" : "Cors", - "locationName" : "corsConfiguration", - "documentation" : "<p>A CORS configuration. Supported only for HTTP APIs.</p>" + "CorsConfiguration": { + "shape": "Cors", + "locationName": "corsConfiguration", + "documentation": "<p>A CORS configuration. Supported only for HTTP APIs.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the API was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the API was created.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the API.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the API.</p>" }, - "DisableSchemaValidation" : { - "shape" : "__boolean", - "locationName" : "disableSchemaValidation", - "documentation" : "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" + "DisableSchemaValidation": { + "shape": "__boolean", + "locationName": "disableSchemaValidation", + "documentation": "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" }, - "DisableExecuteApiEndpoint" : { - "shape" : "__boolean", - "locationName" : "disableExecuteApiEndpoint", - "documentation" : "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" + "DisableExecuteApiEndpoint": { + "shape": "__boolean", + "locationName": "disableExecuteApiEndpoint", + "documentation": "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" }, - "ImportInfo" : { - "shape" : "__listOf__string", - "locationName" : "importInfo", - "documentation" : "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" + "ImportInfo": { + "shape": "__listOf__string", + "locationName": "importInfo", + "documentation": "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the API.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the API.</p>" }, - "ProtocolType" : { - "shape" : "ProtocolType", - "locationName" : "protocolType", - "documentation" : "<p>The API protocol.</p>" + "ProtocolType": { + "shape": "ProtocolType", + "locationName": "protocolType", + "documentation": "<p>The API protocol.</p>" }, - "RouteSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeSelectionExpression", - "documentation" : "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" + "RouteSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeSelectionExpression", + "documentation": "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>A collection of tags associated with the API.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>A collection of tags associated with the API.</p>" }, - "Version" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "version", - "documentation" : "<p>A version identifier for the API.</p>" + "Version": { + "shape": "StringWithLengthBetween1And64", + "locationName": "version", + "documentation": "<p>A version identifier for the API.</p>" }, - "Warnings" : { - "shape" : "__listOf__string", - "locationName" : "warnings", - "documentation" : "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" + "Warnings": { + "shape": "__listOf__string", + "locationName": "warnings", + "documentation": "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" } }, - "documentation" : "<p>Represents an API.</p>", - "required" : [ "RouteSelectionExpression", "Name", "ProtocolType" ] + "documentation": "<p>Represents an API.</p>", + "required": [ + "RouteSelectionExpression", + "Name", + "ProtocolType" + ] }, - "ApiMapping" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "ApiMapping": { + "type": "structure", + "members": { + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiMappingId" : { - "shape" : "Id", - "locationName" : "apiMappingId", - "documentation" : "<p>The API mapping identifier.</p>" + "ApiMappingId": { + "shape": "Id", + "locationName": "apiMappingId", + "documentation": "<p>The API mapping identifier.</p>" }, - "ApiMappingKey" : { - "shape" : "SelectionKey", - "locationName" : "apiMappingKey", - "documentation" : "<p>The API mapping key.</p>" + "ApiMappingKey": { + "shape": "SelectionKey", + "locationName": "apiMappingKey", + "documentation": "<p>The API mapping key.</p>" }, - "Stage" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stage", - "documentation" : "<p>The API stage.</p>" + "Stage": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stage", + "documentation": "<p>The API stage.</p>" } }, - "documentation" : "<p>Represents an API mapping.</p>", - "required" : [ "Stage", "ApiId" ] + "documentation": "<p>Represents an API mapping.</p>", + "required": [ + "Stage", + "ApiId" + ] }, - "ApiMappings" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfApiMapping", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "ApiMappings": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfApiMapping", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>Represents a collection of ApiMappings resources.</p>" + "documentation": "<p>Represents a collection of ApiMappings resources.</p>" }, - "Apis" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfApi", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "Apis": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfApi", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>Represents a collection of APIs.</p>" + "documentation": "<p>Represents a collection of APIs.</p>" }, - "Arn" : { - "type" : "string", - "documentation" : "<p>Represents an Amazon Resource Name (ARN).</p>" + "Arn": { + "type": "string", + "documentation": "<p>Represents an Amazon Resource Name (ARN).</p>" }, - "AuthorizationScopes" : { - "type" : "list", - "documentation" : "<p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>", - "member" : { - "shape" : "StringWithLengthBetween1And64" + "AuthorizationScopes": { + "type": "list", + "documentation": "<p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>", + "member": { + "shape": "StringWithLengthBetween1And64" } }, - "AuthorizationType" : { - "type" : "string", - "documentation" : "<p>The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>", - "enum" : [ "NONE", "AWS_IAM", "CUSTOM", "JWT" ] + "AuthorizationType": { + "type": "string", + "documentation": "<p>The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>", + "enum": [ + "NONE", + "AWS_IAM", + "CUSTOM", + "JWT" + ] }, - "Authorizer" : { - "type" : "structure", - "members" : { - "AuthorizerCredentialsArn" : { - "shape" : "Arn", - "locationName" : "authorizerCredentialsArn", - "documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" + "Authorizer": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "shape": "Arn", + "locationName": "authorizerCredentialsArn", + "documentation": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The authorizer identifier.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The authorizer identifier.</p>" }, - "AuthorizerPayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "authorizerPayloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" + "AuthorizerPayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "authorizerPayloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" }, - "AuthorizerResultTtlInSeconds" : { - "shape" : "IntegerWithLengthBetween0And3600", - "locationName" : "authorizerResultTtlInSeconds", - "documentation" : "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" + "AuthorizerResultTtlInSeconds": { + "shape": "IntegerWithLengthBetween0And3600", + "locationName": "authorizerResultTtlInSeconds", + "documentation": "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" }, - "AuthorizerType" : { - "shape" : "AuthorizerType", - "locationName" : "authorizerType", - "documentation" : "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" + "AuthorizerType": { + "shape": "AuthorizerType", + "locationName": "authorizerType", + "documentation": "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" }, - "AuthorizerUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "authorizerUri", - "documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" + "AuthorizerUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "authorizerUri", + "documentation": "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" }, - "EnableSimpleResponses" : { - "shape" : "__boolean", - "locationName" : "enableSimpleResponses", - "documentation" : "<p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" + "EnableSimpleResponses": { + "shape": "__boolean", + "locationName": "enableSimpleResponses", + "documentation": "<p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" }, - "IdentitySource" : { - "shape" : "IdentitySourceList", - "locationName" : "identitySource", - "documentation" : "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" + "IdentitySource": { + "shape": "IdentitySourceList", + "locationName": "identitySource", + "documentation": "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" }, - "IdentityValidationExpression" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "identityValidationExpression", - "documentation" : "<p>The validation expression does not apply to the REQUEST authorizer.</p>" + "IdentityValidationExpression": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "identityValidationExpression", + "documentation": "<p>The validation expression does not apply to the REQUEST authorizer.</p>" }, - "JwtConfiguration" : { - "shape" : "JWTConfiguration", - "locationName" : "jwtConfiguration", - "documentation" : "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" + "JwtConfiguration": { + "shape": "JWTConfiguration", + "locationName": "jwtConfiguration", + "documentation": "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the authorizer.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the authorizer.</p>" } }, - "documentation" : "<p>Represents an authorizer.</p>", - "required" : [ "Name" ] + "documentation": "<p>Represents an authorizer.</p>", + "required": [ + "Name" + ] }, - "AuthorizerType" : { - "type" : "string", - "documentation" : "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>", - "enum" : [ "REQUEST", "JWT" ] + "AuthorizerType": { + "type": "string", + "documentation": "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>", + "enum": [ + "REQUEST", + "JWT" + ] }, - "Authorizers" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfAuthorizer", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "Authorizers": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfAuthorizer", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>Represents a collection of authorizers.</p>" + "documentation": "<p>Represents a collection of authorizers.</p>" }, - "BadRequestException" : { - "type" : "structure", - "members" : { - "Message" : { - "shape" : "__string", - "locationName" : "message", - "documentation" : "<p>Describes the error encountered.</p>" + "BadRequestException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "<p>Describes the error encountered.</p>" } }, - "documentation" : "<p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>", - "exception" : true, - "error" : { - "httpStatusCode" : 400 + "documentation": "<p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>", + "exception": true, + "error": { + "httpStatusCode": 400 } }, - "ConflictException" : { - "type" : "structure", - "members" : { - "Message" : { - "shape" : "__string", - "locationName" : "message", - "documentation" : "<p>Describes the error encountered.</p>" + "ConflictException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "<p>Describes the error encountered.</p>" } }, - "documentation" : "<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>", - "exception" : true, - "error" : { - "httpStatusCode" : 409 + "documentation": "<p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>", + "exception": true, + "error": { + "httpStatusCode": 409 } }, - "ConnectionType" : { - "type" : "string", - "documentation" : "<p>Represents a connection type.</p>", - "enum" : [ "INTERNET", "VPC_LINK" ] + "ConnectionType": { + "type": "string", + "documentation": "<p>Represents a connection type.</p>", + "enum": [ + "INTERNET", + "VPC_LINK" + ] }, - "ContentHandlingStrategy" : { - "type" : "string", - "documentation" : "<p>Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.</p>", - "enum" : [ "CONVERT_TO_BINARY", "CONVERT_TO_TEXT" ] + "ContentHandlingStrategy": { + "type": "string", + "documentation": "<p>Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.</p>", + "enum": [ + "CONVERT_TO_BINARY", + "CONVERT_TO_TEXT" + ] }, - "Cors" : { - "type" : "structure", - "members" : { - "AllowCredentials" : { - "shape" : "__boolean", - "locationName" : "allowCredentials", - "documentation" : "<p>Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.</p>" + "Cors": { + "type": "structure", + "members": { + "AllowCredentials": { + "shape": "__boolean", + "locationName": "allowCredentials", + "documentation": "<p>Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.</p>" }, - "AllowHeaders" : { - "shape" : "CorsHeaderList", - "locationName" : "allowHeaders", - "documentation" : "<p>Represents a collection of allowed headers. Supported only for HTTP APIs.</p>" + "AllowHeaders": { + "shape": "CorsHeaderList", + "locationName": "allowHeaders", + "documentation": "<p>Represents a collection of allowed headers. Supported only for HTTP APIs.</p>" }, - "AllowMethods" : { - "shape" : "CorsMethodList", - "locationName" : "allowMethods", - "documentation" : "<p>Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.</p>" + "AllowMethods": { + "shape": "CorsMethodList", + "locationName": "allowMethods", + "documentation": "<p>Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.</p>" }, - "AllowOrigins" : { - "shape" : "CorsOriginList", - "locationName" : "allowOrigins", - "documentation" : "<p>Represents a collection of allowed origins. Supported only for HTTP APIs.</p>" + "AllowOrigins": { + "shape": "CorsOriginList", + "locationName": "allowOrigins", + "documentation": "<p>Represents a collection of allowed origins. Supported only for HTTP APIs.</p>" }, - "ExposeHeaders" : { - "shape" : "CorsHeaderList", - "locationName" : "exposeHeaders", - "documentation" : "<p>Represents a collection of exposed headers. Supported only for HTTP APIs.</p>" + "ExposeHeaders": { + "shape": "CorsHeaderList", + "locationName": "exposeHeaders", + "documentation": "<p>Represents a collection of exposed headers. Supported only for HTTP APIs.</p>" }, - "MaxAge" : { - "shape" : "IntegerWithLengthBetweenMinus1And86400", - "locationName" : "maxAge", - "documentation" : "<p>The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.</p>" + "MaxAge": { + "shape": "IntegerWithLengthBetweenMinus1And86400", + "locationName": "maxAge", + "documentation": "<p>The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.</p>" } }, - "documentation" : "<p>Represents a CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information.</p>" + "documentation": "<p>Represents a CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information.</p>" }, - "CorsHeaderList" : { - "type" : "list", - "documentation" : "<p>Represents a collection of allowed headers. Supported only for HTTP APIs.</p>", - "member" : { - "shape" : "__string" + "CorsHeaderList": { + "type": "list", + "documentation": "<p>Represents a collection of allowed headers. Supported only for HTTP APIs.</p>", + "member": { + "shape": "__string" } }, - "CorsMethodList" : { - "type" : "list", - "documentation" : "<p>Represents a collection of methods. Supported only for HTTP APIs.</p>", - "member" : { - "shape" : "StringWithLengthBetween1And64" + "CorsMethodList": { + "type": "list", + "documentation": "<p>Represents a collection of methods. Supported only for HTTP APIs.</p>", + "member": { + "shape": "StringWithLengthBetween1And64" } }, - "CorsOriginList" : { - "type" : "list", - "documentation" : "<p>Represents a collection of origins. Supported only for HTTP APIs.</p>", - "member" : { - "shape" : "__string" + "CorsOriginList": { + "type": "list", + "documentation": "<p>Represents a collection of origins. Supported only for HTTP APIs.</p>", + "member": { + "shape": "__string" } }, - "CreateApiInput" : { - "type" : "structure", - "members" : { - "ApiKeySelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiKeySelectionExpression", - "documentation" : "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" + "CreateApiInput": { + "type": "structure", + "members": { + "ApiKeySelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiKeySelectionExpression", + "documentation": "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" }, - "CorsConfiguration" : { - "shape" : "Cors", - "locationName" : "corsConfiguration", - "documentation" : "<p>A CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information.</p>" + "CorsConfiguration": { + "shape": "Cors", + "locationName": "corsConfiguration", + "documentation": "<p>A CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the API.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the API.</p>" }, - "DisableSchemaValidation" : { - "shape" : "__boolean", - "locationName" : "disableSchemaValidation", - "documentation" : "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" + "DisableSchemaValidation": { + "shape": "__boolean", + "locationName": "disableSchemaValidation", + "documentation": "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" }, - "DisableExecuteApiEndpoint" : { - "shape" : "__boolean", - "locationName" : "disableExecuteApiEndpoint", - "documentation" : "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" + "DisableExecuteApiEndpoint": { + "shape": "__boolean", + "locationName": "disableExecuteApiEndpoint", + "documentation": "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the API.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the API.</p>" }, - "ProtocolType" : { - "shape" : "ProtocolType", - "locationName" : "protocolType", - "documentation" : "<p>The API protocol.</p>" + "ProtocolType": { + "shape": "ProtocolType", + "locationName": "protocolType", + "documentation": "<p>The API protocol.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.</p>" }, - "RouteSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeSelectionExpression", - "documentation" : "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" + "RouteSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeSelectionExpression", + "documentation": "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags. Each tag element is associated with a given resource.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags. Each tag element is associated with a given resource.</p>" }, - "Target" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "target", - "documentation" : "<p>This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.</p>" + "Target": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "target", + "documentation": "<p>This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.</p>" }, - "Version" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "version", - "documentation" : "<p>A version identifier for the API.</p>" + "Version": { + "shape": "StringWithLengthBetween1And64", + "locationName": "version", + "documentation": "<p>A version identifier for the API.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateApi request.</p>", - "required" : [ "ProtocolType", "Name" ] + "documentation": "<p>Represents the input parameters for a CreateApi request.</p>", + "required": [ + "ProtocolType", + "Name" + ] }, - "CreateApiMappingInput" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "CreateApiMappingInput": { + "type": "structure", + "members": { + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiMappingKey" : { - "shape" : "SelectionKey", - "locationName" : "apiMappingKey", - "documentation" : "The API mapping key." + "ApiMappingKey": { + "shape": "SelectionKey", + "locationName": "apiMappingKey", + "documentation": "The API mapping key." }, - "Stage" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stage", - "documentation" : "<p>The API stage.</p>" + "Stage": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stage", + "documentation": "<p>The API stage.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateApiMapping request.</p>", - "required" : [ "Stage", "ApiId" ] + "documentation": "<p>Represents the input parameters for a CreateApiMapping request.</p>", + "required": [ + "Stage", + "ApiId" + ] }, - "CreateApiMappingRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "CreateApiMappingRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiMappingKey" : { - "shape" : "SelectionKey", - "locationName" : "apiMappingKey", - "documentation" : "The API mapping key." + "ApiMappingKey": { + "shape": "SelectionKey", + "locationName": "apiMappingKey", + "documentation": "The API mapping key." }, - "DomainName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "domainName", - "documentation" : "<p>The domain name.</p>" + "DomainName": { + "shape": "__string", + "location": "uri", + "locationName": "domainName", + "documentation": "<p>The domain name.</p>" }, - "Stage" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stage", - "documentation" : "<p>The API stage.</p>" + "Stage": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stage", + "documentation": "<p>The API stage.</p>" } }, - "documentation" : "<p>Creates a new ApiMapping resource to represent an API mapping.</p>", - "required" : [ "DomainName", "Stage", "ApiId" ] + "documentation": "<p>Creates a new ApiMapping resource to represent an API mapping.</p>", + "required": [ + "DomainName", + "Stage", + "ApiId" + ] }, - "CreateApiMappingResponse" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "CreateApiMappingResponse": { + "type": "structure", + "members": { + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiMappingId" : { - "shape" : "Id", - "locationName" : "apiMappingId", - "documentation" : "<p>The API mapping identifier.</p>" + "ApiMappingId": { + "shape": "Id", + "locationName": "apiMappingId", + "documentation": "<p>The API mapping identifier.</p>" }, - "ApiMappingKey" : { - "shape" : "SelectionKey", - "locationName" : "apiMappingKey", - "documentation" : "<p>The API mapping key.</p>" + "ApiMappingKey": { + "shape": "SelectionKey", + "locationName": "apiMappingKey", + "documentation": "<p>The API mapping key.</p>" }, - "Stage" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stage", - "documentation" : "<p>The API stage.</p>" + "Stage": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stage", + "documentation": "<p>The API stage.</p>" } } }, - "CreateApiRequest" : { - "type" : "structure", - "members" : { - "ApiKeySelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiKeySelectionExpression", - "documentation" : "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" + "CreateApiRequest": { + "type": "structure", + "members": { + "ApiKeySelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiKeySelectionExpression", + "documentation": "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" }, - "CorsConfiguration" : { - "shape" : "Cors", - "locationName" : "corsConfiguration", - "documentation" : "<p>A CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information.</p>" + "CorsConfiguration": { + "shape": "Cors", + "locationName": "corsConfiguration", + "documentation": "<p>A CORS configuration. Supported only for HTTP APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html\">Configuring CORS</a> for more information.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the API.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the API.</p>" }, - "DisableSchemaValidation" : { - "shape" : "__boolean", - "locationName" : "disableSchemaValidation", - "documentation" : "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" + "DisableSchemaValidation": { + "shape": "__boolean", + "locationName": "disableSchemaValidation", + "documentation": "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" }, - "DisableExecuteApiEndpoint" : { - "shape" : "__boolean", - "locationName" : "disableExecuteApiEndpoint", - "documentation" : "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" + "DisableExecuteApiEndpoint": { + "shape": "__boolean", + "locationName": "disableExecuteApiEndpoint", + "documentation": "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the API.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the API.</p>" }, - "ProtocolType" : { - "shape" : "ProtocolType", - "locationName" : "protocolType", - "documentation" : "<p>The API protocol.</p>" + "ProtocolType": { + "shape": "ProtocolType", + "locationName": "protocolType", + "documentation": "<p>The API protocol.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.</p>" }, - "RouteSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeSelectionExpression", - "documentation" : "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" + "RouteSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeSelectionExpression", + "documentation": "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags. Each tag element is associated with a given resource.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags. Each tag element is associated with a given resource.</p>" }, - "Target" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "target", - "documentation" : "<p>This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.</p>" + "Target": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "target", + "documentation": "<p>This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.</p>" }, - "Version" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "version", - "documentation" : "<p>A version identifier for the API.</p>" + "Version": { + "shape": "StringWithLengthBetween1And64", + "locationName": "version", + "documentation": "<p>A version identifier for the API.</p>" } }, - "documentation" : "<p>Creates a new Api resource to represent an API.</p>", - "required" : [ "ProtocolType", "Name" ] + "documentation": "<p>Creates a new Api resource to represent an API.</p>", + "required": [ + "ProtocolType", + "Name" + ] }, - "CreateApiResponse" : { - "type" : "structure", - "members" : { - "ApiEndpoint" : { - "shape" : "__string", - "locationName" : "apiEndpoint", - "documentation" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" + "CreateApiResponse": { + "type": "structure", + "members": { + "ApiEndpoint": { + "shape": "__string", + "locationName": "apiEndpoint", + "documentation": "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" }, - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" }, - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API ID.</p>" + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API ID.</p>" }, - "ApiKeySelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiKeySelectionExpression", - "documentation" : "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" + "ApiKeySelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiKeySelectionExpression", + "documentation": "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" }, - "CorsConfiguration" : { - "shape" : "Cors", - "locationName" : "corsConfiguration", - "documentation" : "<p>A CORS configuration. Supported only for HTTP APIs.</p>" + "CorsConfiguration": { + "shape": "Cors", + "locationName": "corsConfiguration", + "documentation": "<p>A CORS configuration. Supported only for HTTP APIs.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the API was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the API was created.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the API.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the API.</p>" }, - "DisableSchemaValidation" : { - "shape" : "__boolean", - "locationName" : "disableSchemaValidation", - "documentation" : "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" + "DisableSchemaValidation": { + "shape": "__boolean", + "locationName": "disableSchemaValidation", + "documentation": "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" }, - "DisableExecuteApiEndpoint" : { - "shape" : "__boolean", - "locationName" : "disableExecuteApiEndpoint", - "documentation" : "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" + "DisableExecuteApiEndpoint": { + "shape": "__boolean", + "locationName": "disableExecuteApiEndpoint", + "documentation": "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" }, - "ImportInfo" : { - "shape" : "__listOf__string", - "locationName" : "importInfo", - "documentation" : "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" + "ImportInfo": { + "shape": "__listOf__string", + "locationName": "importInfo", + "documentation": "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the API.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the API.</p>" }, - "ProtocolType" : { - "shape" : "ProtocolType", - "locationName" : "protocolType", - "documentation" : "<p>The API protocol.</p>" + "ProtocolType": { + "shape": "ProtocolType", + "locationName": "protocolType", + "documentation": "<p>The API protocol.</p>" }, - "RouteSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeSelectionExpression", - "documentation" : "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" + "RouteSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeSelectionExpression", + "documentation": "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>A collection of tags associated with the API.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>A collection of tags associated with the API.</p>" }, - "Version" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "version", - "documentation" : "<p>A version identifier for the API.</p>" + "Version": { + "shape": "StringWithLengthBetween1And64", + "locationName": "version", + "documentation": "<p>A version identifier for the API.</p>" }, - "Warnings" : { - "shape" : "__listOf__string", - "locationName" : "warnings", - "documentation" : "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" + "Warnings": { + "shape": "__listOf__string", + "locationName": "warnings", + "documentation": "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" } } }, - "CreateAuthorizerInput" : { - "type" : "structure", - "members" : { - "AuthorizerCredentialsArn" : { - "shape" : "Arn", - "locationName" : "authorizerCredentialsArn", - "documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" + "CreateAuthorizerInput": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "shape": "Arn", + "locationName": "authorizerCredentialsArn", + "documentation": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" }, - "AuthorizerPayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "authorizerPayloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" + "AuthorizerPayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "authorizerPayloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" }, - "AuthorizerResultTtlInSeconds" : { - "shape" : "IntegerWithLengthBetween0And3600", - "locationName" : "authorizerResultTtlInSeconds", - "documentation" : "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" + "AuthorizerResultTtlInSeconds": { + "shape": "IntegerWithLengthBetween0And3600", + "locationName": "authorizerResultTtlInSeconds", + "documentation": "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" }, - "AuthorizerType" : { - "shape" : "AuthorizerType", - "locationName" : "authorizerType", - "documentation" : "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" + "AuthorizerType": { + "shape": "AuthorizerType", + "locationName": "authorizerType", + "documentation": "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" }, - "AuthorizerUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "authorizerUri", - "documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" + "AuthorizerUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "authorizerUri", + "documentation": "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" }, - "EnableSimpleResponses" : { - "shape" : "__boolean", - "locationName" : "enableSimpleResponses", - "documentation" : "<p>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" + "EnableSimpleResponses": { + "shape": "__boolean", + "locationName": "enableSimpleResponses", + "documentation": "<p>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" }, - "IdentitySource" : { - "shape" : "IdentitySourceList", - "locationName" : "identitySource", - "documentation" : "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" + "IdentitySource": { + "shape": "IdentitySourceList", + "locationName": "identitySource", + "documentation": "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" }, - "IdentityValidationExpression" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "identityValidationExpression", - "documentation" : "<p>This parameter is not used.</p>" + "IdentityValidationExpression": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "identityValidationExpression", + "documentation": "<p>This parameter is not used.</p>" }, - "JwtConfiguration" : { - "shape" : "JWTConfiguration", - "locationName" : "jwtConfiguration", - "documentation" : "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" + "JwtConfiguration": { + "shape": "JWTConfiguration", + "locationName": "jwtConfiguration", + "documentation": "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the authorizer.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the authorizer.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateAuthorizer request.</p>", - "required" : [ "AuthorizerType", "IdentitySource", "Name" ] + "documentation": "<p>Represents the input parameters for a CreateAuthorizer request.</p>", + "required": [ + "AuthorizerType", + "IdentitySource", + "Name" + ] }, - "CreateAuthorizerRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "CreateAuthorizerRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "AuthorizerCredentialsArn" : { - "shape" : "Arn", - "locationName" : "authorizerCredentialsArn", - "documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" + "AuthorizerCredentialsArn": { + "shape": "Arn", + "locationName": "authorizerCredentialsArn", + "documentation": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" }, - "AuthorizerPayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "authorizerPayloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" + "AuthorizerPayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "authorizerPayloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" }, - "AuthorizerResultTtlInSeconds" : { - "shape" : "IntegerWithLengthBetween0And3600", - "locationName" : "authorizerResultTtlInSeconds", - "documentation" : "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" + "AuthorizerResultTtlInSeconds": { + "shape": "IntegerWithLengthBetween0And3600", + "locationName": "authorizerResultTtlInSeconds", + "documentation": "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" }, - "AuthorizerType" : { - "shape" : "AuthorizerType", - "locationName" : "authorizerType", - "documentation" : "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" + "AuthorizerType": { + "shape": "AuthorizerType", + "locationName": "authorizerType", + "documentation": "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" }, - "AuthorizerUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "authorizerUri", - "documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" + "AuthorizerUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "authorizerUri", + "documentation": "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" }, - "EnableSimpleResponses" : { - "shape" : "__boolean", - "locationName" : "enableSimpleResponses", - "documentation" : "<p>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" + "EnableSimpleResponses": { + "shape": "__boolean", + "locationName": "enableSimpleResponses", + "documentation": "<p>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" }, - "IdentitySource" : { - "shape" : "IdentitySourceList", - "locationName" : "identitySource", - "documentation" : "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" + "IdentitySource": { + "shape": "IdentitySourceList", + "locationName": "identitySource", + "documentation": "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" }, - "IdentityValidationExpression" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "identityValidationExpression", - "documentation" : "<p>This parameter is not used.</p>" + "IdentityValidationExpression": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "identityValidationExpression", + "documentation": "<p>This parameter is not used.</p>" }, - "JwtConfiguration" : { - "shape" : "JWTConfiguration", - "locationName" : "jwtConfiguration", - "documentation" : "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" + "JwtConfiguration": { + "shape": "JWTConfiguration", + "locationName": "jwtConfiguration", + "documentation": "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the authorizer.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the authorizer.</p>" } }, - "documentation" : "<p>Creates a new Authorizer resource to represent an authorizer.</p>", - "required" : [ "ApiId", "AuthorizerType", "IdentitySource", "Name" ] + "documentation": "<p>Creates a new Authorizer resource to represent an authorizer.</p>", + "required": [ + "ApiId", + "AuthorizerType", + "IdentitySource", + "Name" + ] }, - "CreateAuthorizerResponse" : { - "type" : "structure", - "members" : { - "AuthorizerCredentialsArn" : { - "shape" : "Arn", - "locationName" : "authorizerCredentialsArn", - "documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" + "CreateAuthorizerResponse": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "shape": "Arn", + "locationName": "authorizerCredentialsArn", + "documentation": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The authorizer identifier.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The authorizer identifier.</p>" }, - "AuthorizerPayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "authorizerPayloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" + "AuthorizerPayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "authorizerPayloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" }, - "AuthorizerResultTtlInSeconds" : { - "shape" : "IntegerWithLengthBetween0And3600", - "locationName" : "authorizerResultTtlInSeconds", - "documentation" : "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" + "AuthorizerResultTtlInSeconds": { + "shape": "IntegerWithLengthBetween0And3600", + "locationName": "authorizerResultTtlInSeconds", + "documentation": "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" }, - "AuthorizerType" : { - "shape" : "AuthorizerType", - "locationName" : "authorizerType", - "documentation" : "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" + "AuthorizerType": { + "shape": "AuthorizerType", + "locationName": "authorizerType", + "documentation": "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" }, - "AuthorizerUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "authorizerUri", - "documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" + "AuthorizerUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "authorizerUri", + "documentation": "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" }, - "EnableSimpleResponses" : { - "shape" : "__boolean", - "locationName" : "enableSimpleResponses", - "documentation" : "<p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" + "EnableSimpleResponses": { + "shape": "__boolean", + "locationName": "enableSimpleResponses", + "documentation": "<p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" }, - "IdentitySource" : { - "shape" : "IdentitySourceList", - "locationName" : "identitySource", - "documentation" : "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" + "IdentitySource": { + "shape": "IdentitySourceList", + "locationName": "identitySource", + "documentation": "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" }, - "IdentityValidationExpression" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "identityValidationExpression", - "documentation" : "<p>The validation expression does not apply to the REQUEST authorizer.</p>" + "IdentityValidationExpression": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "identityValidationExpression", + "documentation": "<p>The validation expression does not apply to the REQUEST authorizer.</p>" }, - "JwtConfiguration" : { - "shape" : "JWTConfiguration", - "locationName" : "jwtConfiguration", - "documentation" : "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" + "JwtConfiguration": { + "shape": "JWTConfiguration", + "locationName": "jwtConfiguration", + "documentation": "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the authorizer.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the authorizer.</p>" } } }, - "CreateDeploymentInput" : { - "type" : "structure", - "members" : { - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the deployment resource.</p>" + "CreateDeploymentInput": { + "type": "structure", + "members": { + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the deployment resource.</p>" }, - "StageName" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stageName", - "documentation" : "<p>The name of the Stage resource for the Deployment resource to create.</p>" + "StageName": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stageName", + "documentation": "<p>The name of the Stage resource for the Deployment resource to create.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateDeployment request.</p>" + "documentation": "<p>Represents the input parameters for a CreateDeployment request.</p>" }, - "CreateDeploymentRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "CreateDeploymentRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the deployment resource.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the deployment resource.</p>" }, - "StageName" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stageName", - "documentation" : "<p>The name of the Stage resource for the Deployment resource to create.</p>" + "StageName": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stageName", + "documentation": "<p>The name of the Stage resource for the Deployment resource to create.</p>" } }, - "documentation" : "<p>Creates a new Deployment resource to represent a deployment.</p>", - "required" : [ "ApiId" ] + "documentation": "<p>Creates a new Deployment resource to represent a deployment.</p>", + "required": [ + "ApiId" + ] }, - "CreateDeploymentResponse" : { - "type" : "structure", - "members" : { - "AutoDeployed" : { - "shape" : "__boolean", - "locationName" : "autoDeployed", - "documentation" : "<p>Specifies whether a deployment was automatically released.</p>" + "CreateDeploymentResponse": { + "type": "structure", + "members": { + "AutoDeployed": { + "shape": "__boolean", + "locationName": "autoDeployed", + "documentation": "<p>Specifies whether a deployment was automatically released.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The date and time when the Deployment resource was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The date and time when the Deployment resource was created.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The identifier for the deployment.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The identifier for the deployment.</p>" }, - "DeploymentStatus" : { - "shape" : "DeploymentStatus", - "locationName" : "deploymentStatus", - "documentation" : "<p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>" + "DeploymentStatus": { + "shape": "DeploymentStatus", + "locationName": "deploymentStatus", + "documentation": "<p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>" }, - "DeploymentStatusMessage" : { - "shape" : "__string", - "locationName" : "deploymentStatusMessage", - "documentation" : "<p>May contain additional feedback on the status of an API deployment.</p>" + "DeploymentStatusMessage": { + "shape": "__string", + "locationName": "deploymentStatusMessage", + "documentation": "<p>May contain additional feedback on the status of an API deployment.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the deployment.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the deployment.</p>" } } }, - "CreateDomainNameInput" : { - "type" : "structure", - "members" : { - "DomainName" : { - "shape" : "StringWithLengthBetween1And512", - "locationName" : "domainName", - "documentation" : "<p>The domain name.</p>" + "CreateDomainNameInput": { + "type": "structure", + "members": { + "DomainName": { + "shape": "StringWithLengthBetween1And512", + "locationName": "domainName", + "documentation": "<p>The domain name.</p>" }, - "DomainNameConfigurations" : { - "shape" : "DomainNameConfigurations", - "locationName" : "domainNameConfigurations", - "documentation" : "<p>The domain name configurations.</p>" + "DomainNameConfigurations": { + "shape": "DomainNameConfigurations", + "locationName": "domainNameConfigurations", + "documentation": "<p>The domain name configurations.</p>" }, - "MutualTlsAuthentication" : { - "shape" : "MutualTlsAuthenticationInput", - "locationName" : "mutualTlsAuthentication", - "documentation" : "<p>The mutual TLS authentication configuration for a custom domain name.</p>" + "MutualTlsAuthentication": { + "shape": "MutualTlsAuthenticationInput", + "locationName": "mutualTlsAuthentication", + "documentation": "<p>The mutual TLS authentication configuration for a custom domain name.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags associated with a domain name.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags associated with a domain name.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateDomainName request.</p>", - "required" : [ "DomainName" ] + "documentation": "<p>Represents the input parameters for a CreateDomainName request.</p>", + "required": [ + "DomainName" + ] }, - "CreateDomainNameRequest" : { - "type" : "structure", - "members" : { - "DomainName" : { - "shape" : "StringWithLengthBetween1And512", - "locationName" : "domainName", - "documentation" : "<p>The domain name.</p>" + "CreateDomainNameRequest": { + "type": "structure", + "members": { + "DomainName": { + "shape": "StringWithLengthBetween1And512", + "locationName": "domainName", + "documentation": "<p>The domain name.</p>" }, - "DomainNameConfigurations" : { - "shape" : "DomainNameConfigurations", - "locationName" : "domainNameConfigurations", - "documentation" : "<p>The domain name configurations.</p>" + "DomainNameConfigurations": { + "shape": "DomainNameConfigurations", + "locationName": "domainNameConfigurations", + "documentation": "<p>The domain name configurations.</p>" }, - "MutualTlsAuthentication" : { - "shape" : "MutualTlsAuthenticationInput", - "locationName" : "mutualTlsAuthentication", - "documentation" : "<p>The mutual TLS authentication configuration for a custom domain name.</p>" + "MutualTlsAuthentication": { + "shape": "MutualTlsAuthenticationInput", + "locationName": "mutualTlsAuthentication", + "documentation": "<p>The mutual TLS authentication configuration for a custom domain name.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags associated with a domain name.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags associated with a domain name.</p>" } }, - "documentation" : "<p>Creates a new DomainName resource to represent a domain name.</p>", - "required" : [ "DomainName" ] + "documentation": "<p>Creates a new DomainName resource to represent a domain name.</p>", + "required": [ + "DomainName" + ] }, - "CreateDomainNameResponse" : { - "type" : "structure", - "members" : { - "ApiMappingSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiMappingSelectionExpression", - "documentation" : "<p>The API mapping selection expression.</p>" + "CreateDomainNameResponse": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiMappingSelectionExpression", + "documentation": "<p>The API mapping selection expression.</p>" }, - "DomainName" : { - "shape" : "StringWithLengthBetween1And512", - "locationName" : "domainName", - "documentation" : "<p>The name of the DomainName resource.</p>" + "DomainName": { + "shape": "StringWithLengthBetween1And512", + "locationName": "domainName", + "documentation": "<p>The name of the DomainName resource.</p>" }, - "DomainNameConfigurations" : { - "shape" : "DomainNameConfigurations", - "locationName" : "domainNameConfigurations", - "documentation" : "<p>The domain name configurations.</p>" + "DomainNameConfigurations": { + "shape": "DomainNameConfigurations", + "locationName": "domainNameConfigurations", + "documentation": "<p>The domain name configurations.</p>" }, - "MutualTlsAuthentication" : { - "shape" : "MutualTlsAuthentication", - "locationName" : "mutualTlsAuthentication", - "documentation" : "<p>The mutual TLS authentication configuration for a custom domain name.</p>" + "MutualTlsAuthentication": { + "shape": "MutualTlsAuthentication", + "locationName": "mutualTlsAuthentication", + "documentation": "<p>The mutual TLS authentication configuration for a custom domain name.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags associated with a domain name.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags associated with a domain name.</p>" } } }, - "CreateIntegrationInput" : { - "type" : "structure", - "members" : { - "ConnectionId" : { - "shape" : "StringWithLengthBetween1And1024", - "locationName" : "connectionId", - "documentation" : "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" + "CreateIntegrationInput": { + "type": "structure", + "members": { + "ConnectionId": { + "shape": "StringWithLengthBetween1And1024", + "locationName": "connectionId", + "documentation": "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" }, - "ConnectionType" : { - "shape" : "ConnectionType", - "locationName" : "connectionType", - "documentation" : "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" + "ConnectionType": { + "shape": "ConnectionType", + "locationName": "connectionType", + "documentation": "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" }, - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the integration.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the integration.</p>" }, - "IntegrationMethod" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "integrationMethod", - "documentation" : "<p>Specifies the integration's HTTP method type.</p>" + "IntegrationMethod": { + "shape": "StringWithLengthBetween1And64", + "locationName": "integrationMethod", + "documentation": "<p>Specifies the integration's HTTP method type.</p>" }, - "IntegrationSubtype" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "integrationSubtype", - "documentation" : "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" + "IntegrationSubtype": { + "shape": "StringWithLengthBetween1And128", + "locationName": "integrationSubtype", + "documentation": "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" }, - "IntegrationType" : { - "shape" : "IntegrationType", - "locationName" : "integrationType", - "documentation" : "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" + "IntegrationType": { + "shape": "IntegrationType", + "locationName": "integrationType", + "documentation": "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" }, - "IntegrationUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "integrationUri", - "documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" + "IntegrationUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "integrationUri", + "documentation": "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" }, - "PassthroughBehavior" : { - "shape" : "PassthroughBehavior", - "locationName" : "passthroughBehavior", - "documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" + "PassthroughBehavior": { + "shape": "PassthroughBehavior", + "locationName": "passthroughBehavior", + "documentation": "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" }, - "PayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "payloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>" + "PayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "payloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>" }, - "RequestParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "requestParameters", - "documentation" : "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "RequestParameters": { + "shape": "IntegrationParameters", + "locationName": "requestParameters", + "documentation": "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "RequestTemplates" : { - "shape" : "TemplateMap", - "locationName" : "requestTemplates", - "documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" + "RequestTemplates": { + "shape": "TemplateMap", + "locationName": "requestTemplates", + "documentation": "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" }, - "ResponseParameters" : { - "shape" : "ResponseParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "ResponseParameters": { + "shape": "ResponseParameters", + "locationName": "responseParameters", + "documentation": "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration.</p>" }, - "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And30000", - "locationName" : "timeoutInMillis", - "documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" + "TimeoutInMillis": { + "shape": "IntegerWithLengthBetween50And30000", + "locationName": "timeoutInMillis", + "documentation": "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" }, - "TlsConfig" : { - "shape" : "TlsConfigInput", - "locationName" : "tlsConfig", - "documentation" : "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" + "TlsConfig": { + "shape": "TlsConfigInput", + "locationName": "tlsConfig", + "documentation": "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateIntegration request.</p>", - "required" : [ "IntegrationType" ] + "documentation": "<p>Represents the input parameters for a CreateIntegration request.</p>", + "required": [ + "IntegrationType" + ] }, - "CreateIntegrationRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "CreateIntegrationRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ConnectionId" : { - "shape" : "StringWithLengthBetween1And1024", - "locationName" : "connectionId", - "documentation" : "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" + "ConnectionId": { + "shape": "StringWithLengthBetween1And1024", + "locationName": "connectionId", + "documentation": "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" }, - "ConnectionType" : { - "shape" : "ConnectionType", - "locationName" : "connectionType", - "documentation" : "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" + "ConnectionType": { + "shape": "ConnectionType", + "locationName": "connectionType", + "documentation": "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" }, - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the integration.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the integration.</p>" }, - "IntegrationMethod" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "integrationMethod", - "documentation" : "<p>Specifies the integration's HTTP method type.</p>" + "IntegrationMethod": { + "shape": "StringWithLengthBetween1And64", + "locationName": "integrationMethod", + "documentation": "<p>Specifies the integration's HTTP method type.</p>" }, - "IntegrationSubtype" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "integrationSubtype", - "documentation" : "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" + "IntegrationSubtype": { + "shape": "StringWithLengthBetween1And128", + "locationName": "integrationSubtype", + "documentation": "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" }, - "IntegrationType" : { - "shape" : "IntegrationType", - "locationName" : "integrationType", - "documentation" : "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" + "IntegrationType": { + "shape": "IntegrationType", + "locationName": "integrationType", + "documentation": "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" }, - "IntegrationUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "integrationUri", - "documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" + "IntegrationUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "integrationUri", + "documentation": "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" }, - "PassthroughBehavior" : { - "shape" : "PassthroughBehavior", - "locationName" : "passthroughBehavior", - "documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" + "PassthroughBehavior": { + "shape": "PassthroughBehavior", + "locationName": "passthroughBehavior", + "documentation": "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" }, - "PayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "payloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>" + "PayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "payloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>" }, - "RequestParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "requestParameters", - "documentation" : "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "RequestParameters": { + "shape": "IntegrationParameters", + "locationName": "requestParameters", + "documentation": "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "RequestTemplates" : { - "shape" : "TemplateMap", - "locationName" : "requestTemplates", - "documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" + "RequestTemplates": { + "shape": "TemplateMap", + "locationName": "requestTemplates", + "documentation": "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" }, - "ResponseParameters" : { - "shape" : "ResponseParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "ResponseParameters": { + "shape": "ResponseParameters", + "locationName": "responseParameters", + "documentation": "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration.</p>" }, - "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And30000", - "locationName" : "timeoutInMillis", - "documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" + "TimeoutInMillis": { + "shape": "IntegerWithLengthBetween50And30000", + "locationName": "timeoutInMillis", + "documentation": "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" }, - "TlsConfig" : { - "shape" : "TlsConfigInput", - "locationName" : "tlsConfig", - "documentation" : "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" + "TlsConfig": { + "shape": "TlsConfigInput", + "locationName": "tlsConfig", + "documentation": "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" } }, - "documentation" : "<p>Creates a new Integration resource to represent an integration.</p>", - "required" : [ "ApiId", "IntegrationType" ] + "documentation": "<p>Creates a new Integration resource to represent an integration.</p>", + "required": [ + "ApiId", + "IntegrationType" + ] }, - "CreateIntegrationResult" : { - "type" : "structure", - "members" : { - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>" + "CreateIntegrationResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>" }, - "ConnectionId" : { - "shape" : "StringWithLengthBetween1And1024", - "locationName" : "connectionId", - "documentation" : "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" + "ConnectionId": { + "shape": "StringWithLengthBetween1And1024", + "locationName": "connectionId", + "documentation": "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" }, - "ConnectionType" : { - "shape" : "ConnectionType", - "locationName" : "connectionType", - "documentation" : "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" + "ConnectionType": { + "shape": "ConnectionType", + "locationName": "connectionType", + "documentation": "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" }, - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>Represents the description of an integration.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>Represents the description of an integration.</p>" }, - "IntegrationId" : { - "shape" : "Id", - "locationName" : "integrationId", - "documentation" : "<p>Represents the identifier of an integration.</p>" + "IntegrationId": { + "shape": "Id", + "locationName": "integrationId", + "documentation": "<p>Represents the identifier of an integration.</p>" }, - "IntegrationMethod" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "integrationMethod", - "documentation" : "<p>Specifies the integration's HTTP method type.</p>" + "IntegrationMethod": { + "shape": "StringWithLengthBetween1And64", + "locationName": "integrationMethod", + "documentation": "<p>Specifies the integration's HTTP method type.</p>" }, - "IntegrationResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "integrationResponseSelectionExpression", - "documentation" : "<p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>" + "IntegrationResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "integrationResponseSelectionExpression", + "documentation": "<p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>" }, - "IntegrationSubtype" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "integrationSubtype", - "documentation" : "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" + "IntegrationSubtype": { + "shape": "StringWithLengthBetween1And128", + "locationName": "integrationSubtype", + "documentation": "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" }, - "IntegrationType" : { - "shape" : "IntegrationType", - "locationName" : "integrationType", - "documentation" : "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" + "IntegrationType": { + "shape": "IntegrationType", + "locationName": "integrationType", + "documentation": "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" }, - "IntegrationUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "integrationUri", - "documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" + "IntegrationUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "integrationUri", + "documentation": "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" }, - "PassthroughBehavior" : { - "shape" : "PassthroughBehavior", - "locationName" : "passthroughBehavior", - "documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" + "PassthroughBehavior": { + "shape": "PassthroughBehavior", + "locationName": "passthroughBehavior", + "documentation": "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" }, - "PayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "payloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>" + "PayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "payloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>" }, - "RequestParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "requestParameters", - "documentation" : "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "RequestParameters": { + "shape": "IntegrationParameters", + "locationName": "requestParameters", + "documentation": "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "RequestTemplates" : { - "shape" : "TemplateMap", - "locationName" : "requestTemplates", - "documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" + "RequestTemplates": { + "shape": "TemplateMap", + "locationName": "requestTemplates", + "documentation": "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" }, - "ResponseParameters" : { - "shape" : "ResponseParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "ResponseParameters": { + "shape": "ResponseParameters", + "locationName": "responseParameters", + "documentation": "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>" }, - "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And30000", - "locationName" : "timeoutInMillis", - "documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" + "TimeoutInMillis": { + "shape": "IntegerWithLengthBetween50And30000", + "locationName": "timeoutInMillis", + "documentation": "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" }, - "TlsConfig" : { - "shape" : "TlsConfig", - "locationName" : "tlsConfig", - "documentation" : "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" + "TlsConfig": { + "shape": "TlsConfig", + "locationName": "tlsConfig", + "documentation": "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" } } }, - "CreateIntegrationResponseInput" : { - "type" : "structure", - "members" : { - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "CreateIntegrationResponseInput": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "IntegrationResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "integrationResponseKey", - "documentation" : "<p>The integration response key.</p>" + "IntegrationResponseKey": { + "shape": "SelectionKey", + "locationName": "integrationResponseKey", + "documentation": "<p>The integration response key.</p>" }, - "ResponseParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "responseParameters", - "documentation" : "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.</p>" + "ResponseParameters": { + "shape": "IntegrationParameters", + "locationName": "responseParameters", + "documentation": "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.</p>" }, - "ResponseTemplates" : { - "shape" : "TemplateMap", - "locationName" : "responseTemplates", - "documentation" : "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" + "ResponseTemplates": { + "shape": "TemplateMap", + "locationName": "responseTemplates", + "documentation": "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration response. Supported only for WebSocket APIs.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration response. Supported only for WebSocket APIs.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateIntegrationResponse request.</p>", - "required" : [ "IntegrationResponseKey" ] + "documentation": "<p>Represents the input parameters for a CreateIntegrationResponse request.</p>", + "required": [ + "IntegrationResponseKey" + ] }, - "CreateIntegrationResponseRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "CreateIntegrationResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "IntegrationId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationId", - "documentation" : "<p>The integration ID.</p>" + "IntegrationId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationId", + "documentation": "<p>The integration ID.</p>" }, - "IntegrationResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "integrationResponseKey", - "documentation" : "<p>The integration response key.</p>" + "IntegrationResponseKey": { + "shape": "SelectionKey", + "locationName": "integrationResponseKey", + "documentation": "<p>The integration response key.</p>" }, - "ResponseParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "responseParameters", - "documentation" : "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.</p>" + "ResponseParameters": { + "shape": "IntegrationParameters", + "locationName": "responseParameters", + "documentation": "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.</p>" }, - "ResponseTemplates" : { - "shape" : "TemplateMap", - "locationName" : "responseTemplates", - "documentation" : "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" + "ResponseTemplates": { + "shape": "TemplateMap", + "locationName": "responseTemplates", + "documentation": "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration response. Supported only for WebSocket APIs.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration response. Supported only for WebSocket APIs.</p>" } }, - "documentation" : "<p>Creates a new IntegrationResponse resource to represent an integration response.</p>", - "required" : [ "ApiId", "IntegrationId", "IntegrationResponseKey" ] + "documentation": "<p>Creates a new IntegrationResponse resource to represent an integration response.</p>", + "required": [ + "ApiId", + "IntegrationId", + "IntegrationResponseKey" + ] }, - "CreateIntegrationResponseResponse" : { - "type" : "structure", - "members" : { - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "CreateIntegrationResponseResponse": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "IntegrationResponseId" : { - "shape" : "Id", - "locationName" : "integrationResponseId", - "documentation" : "<p>The integration response ID.</p>" + "IntegrationResponseId": { + "shape": "Id", + "locationName": "integrationResponseId", + "documentation": "<p>The integration response ID.</p>" }, - "IntegrationResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "integrationResponseKey", - "documentation" : "<p>The integration response key.</p>" + "IntegrationResponseKey": { + "shape": "SelectionKey", + "locationName": "integrationResponseKey", + "documentation": "<p>The integration response key.</p>" }, - "ResponseParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "responseParameters", - "documentation" : "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>" + "ResponseParameters": { + "shape": "IntegrationParameters", + "locationName": "responseParameters", + "documentation": "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>" }, - "ResponseTemplates" : { - "shape" : "TemplateMap", - "locationName" : "responseTemplates", - "documentation" : "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" + "ResponseTemplates": { + "shape": "TemplateMap", + "locationName": "responseTemplates", + "documentation": "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expressions for the integration response.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expressions for the integration response.</p>" } } }, - "CreateModelInput" : { - "type" : "structure", - "members" : { - "ContentType" : { - "shape" : "StringWithLengthBetween1And256", - "locationName" : "contentType", - "documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>" + "CreateModelInput": { + "type": "structure", + "members": { + "ContentType": { + "shape": "StringWithLengthBetween1And256", + "locationName": "contentType", + "documentation": "<p>The content-type for the model, for example, \"application/json\".</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the model.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the model.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the model. Must be alphanumeric.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the model. Must be alphanumeric.</p>" }, - "Schema" : { - "shape" : "StringWithLengthBetween0And32K", - "locationName" : "schema", - "documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" + "Schema": { + "shape": "StringWithLengthBetween0And32K", + "locationName": "schema", + "documentation": "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateModel request.</p>", - "required" : [ "Schema", "Name" ] + "documentation": "<p>Represents the input parameters for a CreateModel request.</p>", + "required": [ + "Schema", + "Name" + ] }, - "CreateModelRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "CreateModelRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ContentType" : { - "shape" : "StringWithLengthBetween1And256", - "locationName" : "contentType", - "documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>" + "ContentType": { + "shape": "StringWithLengthBetween1And256", + "locationName": "contentType", + "documentation": "<p>The content-type for the model, for example, \"application/json\".</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the model.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the model.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the model. Must be alphanumeric.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the model. Must be alphanumeric.</p>" }, - "Schema" : { - "shape" : "StringWithLengthBetween0And32K", - "locationName" : "schema", - "documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" + "Schema": { + "shape": "StringWithLengthBetween0And32K", + "locationName": "schema", + "documentation": "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" } }, - "documentation" : "<p>Creates a new Model.</p>", - "required" : [ "ApiId", "Schema", "Name" ] + "documentation": "<p>Creates a new Model.</p>", + "required": [ + "ApiId", + "Schema", + "Name" + ] }, - "CreateModelResponse" : { - "type" : "structure", - "members" : { - "ContentType" : { - "shape" : "StringWithLengthBetween1And256", - "locationName" : "contentType", - "documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>" + "CreateModelResponse": { + "type": "structure", + "members": { + "ContentType": { + "shape": "StringWithLengthBetween1And256", + "locationName": "contentType", + "documentation": "<p>The content-type for the model, for example, \"application/json\".</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the model.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the model.</p>" }, - "ModelId" : { - "shape" : "Id", - "locationName" : "modelId", - "documentation" : "<p>The model identifier.</p>" + "ModelId": { + "shape": "Id", + "locationName": "modelId", + "documentation": "<p>The model identifier.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the model. Must be alphanumeric.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the model. Must be alphanumeric.</p>" }, - "Schema" : { - "shape" : "StringWithLengthBetween0And32K", - "locationName" : "schema", - "documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" + "Schema": { + "shape": "StringWithLengthBetween0And32K", + "locationName": "schema", + "documentation": "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" } } }, - "CreateRouteInput" : { - "type" : "structure", - "members" : { - "ApiKeyRequired" : { - "shape" : "__boolean", - "locationName" : "apiKeyRequired", - "documentation" : "<p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>" + "CreateRouteInput": { + "type": "structure", + "members": { + "ApiKeyRequired": { + "shape": "__boolean", + "locationName": "apiKeyRequired", + "documentation": "<p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>" }, - "AuthorizationScopes" : { - "shape" : "AuthorizationScopes", - "locationName" : "authorizationScopes", - "documentation" : "<p>The authorization scopes supported by this route.</p>" + "AuthorizationScopes": { + "shape": "AuthorizationScopes", + "locationName": "authorizationScopes", + "documentation": "<p>The authorization scopes supported by this route.</p>" }, - "AuthorizationType" : { - "shape" : "AuthorizationType", - "locationName" : "authorizationType", - "documentation" : "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" + "AuthorizationType": { + "shape": "AuthorizationType", + "locationName": "authorizationType", + "documentation": "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" }, - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "OperationName" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "operationName", - "documentation" : "<p>The operation name for the route.</p>" + "OperationName": { + "shape": "StringWithLengthBetween1And64", + "locationName": "operationName", + "documentation": "<p>The operation name for the route.</p>" }, - "RequestModels" : { - "shape" : "RouteModels", - "locationName" : "requestModels", - "documentation" : "<p>The request models for the route. Supported only for WebSocket APIs.</p>" + "RequestModels": { + "shape": "RouteModels", + "locationName": "requestModels", + "documentation": "<p>The request models for the route. Supported only for WebSocket APIs.</p>" }, - "RequestParameters" : { - "shape" : "RouteParameters", - "locationName" : "requestParameters", - "documentation" : "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" + "RequestParameters": { + "shape": "RouteParameters", + "locationName": "requestParameters", + "documentation": "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>The route key for the route.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>The route key for the route.</p>" }, - "RouteResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeResponseSelectionExpression", - "documentation" : "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" + "RouteResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeResponseSelectionExpression", + "documentation": "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "Target" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "target", - "documentation" : "<p>The target for the route.</p>" + "Target": { + "shape": "StringWithLengthBetween1And128", + "locationName": "target", + "documentation": "<p>The target for the route.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateRoute request.</p>", - "required" : [ "RouteKey" ] + "documentation": "<p>Represents the input parameters for a CreateRoute request.</p>", + "required": [ + "RouteKey" + ] }, - "CreateRouteRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "CreateRouteRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiKeyRequired" : { - "shape" : "__boolean", - "locationName" : "apiKeyRequired", - "documentation" : "<p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>" + "ApiKeyRequired": { + "shape": "__boolean", + "locationName": "apiKeyRequired", + "documentation": "<p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>" }, - "AuthorizationScopes" : { - "shape" : "AuthorizationScopes", - "locationName" : "authorizationScopes", - "documentation" : "<p>The authorization scopes supported by this route.</p>" + "AuthorizationScopes": { + "shape": "AuthorizationScopes", + "locationName": "authorizationScopes", + "documentation": "<p>The authorization scopes supported by this route.</p>" }, - "AuthorizationType" : { - "shape" : "AuthorizationType", - "locationName" : "authorizationType", - "documentation" : "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" + "AuthorizationType": { + "shape": "AuthorizationType", + "locationName": "authorizationType", + "documentation": "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" }, - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "OperationName" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "operationName", - "documentation" : "<p>The operation name for the route.</p>" + "OperationName": { + "shape": "StringWithLengthBetween1And64", + "locationName": "operationName", + "documentation": "<p>The operation name for the route.</p>" }, - "RequestModels" : { - "shape" : "RouteModels", - "locationName" : "requestModels", - "documentation" : "<p>The request models for the route. Supported only for WebSocket APIs.</p>" + "RequestModels": { + "shape": "RouteModels", + "locationName": "requestModels", + "documentation": "<p>The request models for the route. Supported only for WebSocket APIs.</p>" }, - "RequestParameters" : { - "shape" : "RouteParameters", - "locationName" : "requestParameters", - "documentation" : "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" + "RequestParameters": { + "shape": "RouteParameters", + "locationName": "requestParameters", + "documentation": "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>The route key for the route.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>The route key for the route.</p>" }, - "RouteResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeResponseSelectionExpression", - "documentation" : "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" + "RouteResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeResponseSelectionExpression", + "documentation": "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "Target" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "target", - "documentation" : "<p>The target for the route.</p>" + "Target": { + "shape": "StringWithLengthBetween1And128", + "locationName": "target", + "documentation": "<p>The target for the route.</p>" } }, - "documentation" : "<p>Creates a new Route resource to represent a route.</p>", - "required" : [ "ApiId", "RouteKey" ] + "documentation": "<p>Creates a new Route resource to represent a route.</p>", + "required": [ + "ApiId", + "RouteKey" + ] }, - "CreateRouteResult" : { - "type" : "structure", - "members" : { - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>" + "CreateRouteResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>" }, - "ApiKeyRequired" : { - "shape" : "__boolean", - "locationName" : "apiKeyRequired", - "documentation" : "<p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>" + "ApiKeyRequired": { + "shape": "__boolean", + "locationName": "apiKeyRequired", + "documentation": "<p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>" }, - "AuthorizationScopes" : { - "shape" : "AuthorizationScopes", - "locationName" : "authorizationScopes", - "documentation" : "<p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>" + "AuthorizationScopes": { + "shape": "AuthorizationScopes", + "locationName": "authorizationScopes", + "documentation": "<p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>" }, - "AuthorizationType" : { - "shape" : "AuthorizationType", - "locationName" : "authorizationType", - "documentation" : "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" + "AuthorizationType": { + "shape": "AuthorizationType", + "locationName": "authorizationType", + "documentation": "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" }, - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "OperationName" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "operationName", - "documentation" : "<p>The operation name for the route.</p>" + "OperationName": { + "shape": "StringWithLengthBetween1And64", + "locationName": "operationName", + "documentation": "<p>The operation name for the route.</p>" }, - "RequestModels" : { - "shape" : "RouteModels", - "locationName" : "requestModels", - "documentation" : "<p>The request models for the route. Supported only for WebSocket APIs.</p>" + "RequestModels": { + "shape": "RouteModels", + "locationName": "requestModels", + "documentation": "<p>The request models for the route. Supported only for WebSocket APIs.</p>" }, - "RequestParameters" : { - "shape" : "RouteParameters", - "locationName" : "requestParameters", - "documentation" : "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" + "RequestParameters": { + "shape": "RouteParameters", + "locationName": "requestParameters", + "documentation": "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" }, - "RouteId" : { - "shape" : "Id", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "Id", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>The route key for the route.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>The route key for the route.</p>" }, - "RouteResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeResponseSelectionExpression", - "documentation" : "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" + "RouteResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeResponseSelectionExpression", + "documentation": "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "Target" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "target", - "documentation" : "<p>The target for the route.</p>" + "Target": { + "shape": "StringWithLengthBetween1And128", + "locationName": "target", + "documentation": "<p>The target for the route.</p>" } } }, - "CreateRouteResponseInput" : { - "type" : "structure", - "members" : { - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>" + "CreateRouteResponseInput": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>" }, - "ResponseModels" : { - "shape" : "RouteModels", - "locationName" : "responseModels", - "documentation" : "<p>The response models for the route response.</p>" + "ResponseModels": { + "shape": "RouteModels", + "locationName": "responseModels", + "documentation": "<p>The response models for the route response.</p>" }, - "ResponseParameters" : { - "shape" : "RouteParameters", - "locationName" : "responseParameters", - "documentation" : "<p>The route response parameters.</p>" + "ResponseParameters": { + "shape": "RouteParameters", + "locationName": "responseParameters", + "documentation": "<p>The route response parameters.</p>" }, - "RouteResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "routeResponseKey", - "documentation" : "<p>The route response key.</p>" + "RouteResponseKey": { + "shape": "SelectionKey", + "locationName": "routeResponseKey", + "documentation": "<p>The route response key.</p>" } }, - "documentation" : "<p>Represents the input parameters for an CreateRouteResponse request.</p>", - "required" : [ "RouteResponseKey" ] + "documentation": "<p>Represents the input parameters for an CreateRouteResponse request.</p>", + "required": [ + "RouteResponseKey" + ] }, - "CreateRouteResponseRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "CreateRouteResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>" + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>" }, - "ResponseModels" : { - "shape" : "RouteModels", - "locationName" : "responseModels", - "documentation" : "<p>The response models for the route response.</p>" + "ResponseModels": { + "shape": "RouteModels", + "locationName": "responseModels", + "documentation": "<p>The response models for the route response.</p>" }, - "ResponseParameters" : { - "shape" : "RouteParameters", - "locationName" : "responseParameters", - "documentation" : "<p>The route response parameters.</p>" + "ResponseParameters": { + "shape": "RouteParameters", + "locationName": "responseParameters", + "documentation": "<p>The route response parameters.</p>" }, - "RouteId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "__string", + "location": "uri", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" }, - "RouteResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "routeResponseKey", - "documentation" : "<p>The route response key.</p>" + "RouteResponseKey": { + "shape": "SelectionKey", + "locationName": "routeResponseKey", + "documentation": "<p>The route response key.</p>" } }, - "documentation" : "<p>Creates a new RouteResponse resource to represent a route response.</p>", - "required" : [ "ApiId", "RouteId", "RouteResponseKey" ] + "documentation": "<p>Creates a new RouteResponse resource to represent a route response.</p>", + "required": [ + "ApiId", + "RouteId", + "RouteResponseKey" + ] }, - "CreateRouteResponseResponse" : { - "type" : "structure", - "members" : { - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>" + "CreateRouteResponseResponse": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>" }, - "ResponseModels" : { - "shape" : "RouteModels", - "locationName" : "responseModels", - "documentation" : "<p>Represents the response models of a route response.</p>" + "ResponseModels": { + "shape": "RouteModels", + "locationName": "responseModels", + "documentation": "<p>Represents the response models of a route response.</p>" }, - "ResponseParameters" : { - "shape" : "RouteParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Represents the response parameters of a route response.</p>" + "ResponseParameters": { + "shape": "RouteParameters", + "locationName": "responseParameters", + "documentation": "<p>Represents the response parameters of a route response.</p>" }, - "RouteResponseId" : { - "shape" : "Id", - "locationName" : "routeResponseId", - "documentation" : "<p>Represents the identifier of a route response.</p>" + "RouteResponseId": { + "shape": "Id", + "locationName": "routeResponseId", + "documentation": "<p>Represents the identifier of a route response.</p>" }, - "RouteResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "routeResponseKey", - "documentation" : "<p>Represents the route response key of a route response.</p>" + "RouteResponseKey": { + "shape": "SelectionKey", + "locationName": "routeResponseKey", + "documentation": "<p>Represents the route response key of a route response.</p>" } } }, - "CreateStageInput" : { - "type" : "structure", - "members" : { - "AccessLogSettings" : { - "shape" : "AccessLogSettings", - "locationName" : "accessLogSettings", - "documentation" : "<p>Settings for logging access in this stage.</p>" + "CreateStageInput": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "AccessLogSettings", + "locationName": "accessLogSettings", + "documentation": "<p>Settings for logging access in this stage.</p>" }, - "AutoDeploy" : { - "shape" : "__boolean", - "locationName" : "autoDeploy", - "documentation" : "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" + "AutoDeploy": { + "shape": "__boolean", + "locationName": "autoDeploy", + "documentation": "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" }, - "ClientCertificateId" : { - "shape" : "Id", - "locationName" : "clientCertificateId", - "documentation" : "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" + "ClientCertificateId": { + "shape": "Id", + "locationName": "clientCertificateId", + "documentation": "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" }, - "DefaultRouteSettings" : { - "shape" : "RouteSettings", - "locationName" : "defaultRouteSettings", - "documentation" : "<p>The default route settings for the stage.</p>" + "DefaultRouteSettings": { + "shape": "RouteSettings", + "locationName": "defaultRouteSettings", + "documentation": "<p>The default route settings for the stage.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The deployment identifier of the API stage.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The deployment identifier of the API stage.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the API stage.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the API stage.</p>" }, - "RouteSettings" : { - "shape" : "RouteSettingsMap", - "locationName" : "routeSettings", - "documentation" : "<p>Route settings for the stage, by routeKey.</p>" + "RouteSettings": { + "shape": "RouteSettingsMap", + "locationName": "routeSettings", + "documentation": "<p>Route settings for the stage, by routeKey.</p>" }, - "StageName" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stageName", - "documentation" : "<p>The name of the stage.</p>" + "StageName": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stageName", + "documentation": "<p>The name of the stage.</p>" }, - "StageVariables" : { - "shape" : "StageVariablesMap", - "locationName" : "stageVariables", - "documentation" : "<p>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" + "StageVariables": { + "shape": "StageVariablesMap", + "locationName": "stageVariables", + "documentation": "<p>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags. Each tag element is associated with a given resource.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags. Each tag element is associated with a given resource.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateStage request.</p>", - "required" : [ "StageName" ] + "documentation": "<p>Represents the input parameters for a CreateStage request.</p>", + "required": [ + "StageName" + ] }, - "CreateStageRequest" : { - "type" : "structure", - "members" : { - "AccessLogSettings" : { - "shape" : "AccessLogSettings", - "locationName" : "accessLogSettings", - "documentation" : "<p>Settings for logging access in this stage.</p>" + "CreateStageRequest": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "AccessLogSettings", + "locationName": "accessLogSettings", + "documentation": "<p>Settings for logging access in this stage.</p>" }, - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "AutoDeploy" : { - "shape" : "__boolean", - "locationName" : "autoDeploy", - "documentation" : "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" + "AutoDeploy": { + "shape": "__boolean", + "locationName": "autoDeploy", + "documentation": "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" }, - "ClientCertificateId" : { - "shape" : "Id", - "locationName" : "clientCertificateId", - "documentation" : "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" + "ClientCertificateId": { + "shape": "Id", + "locationName": "clientCertificateId", + "documentation": "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" }, - "DefaultRouteSettings" : { - "shape" : "RouteSettings", - "locationName" : "defaultRouteSettings", - "documentation" : "<p>The default route settings for the stage.</p>" + "DefaultRouteSettings": { + "shape": "RouteSettings", + "locationName": "defaultRouteSettings", + "documentation": "<p>The default route settings for the stage.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The deployment identifier of the API stage.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The deployment identifier of the API stage.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the API stage.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the API stage.</p>" }, - "RouteSettings" : { - "shape" : "RouteSettingsMap", - "locationName" : "routeSettings", - "documentation" : "<p>Route settings for the stage, by routeKey.</p>" + "RouteSettings": { + "shape": "RouteSettingsMap", + "locationName": "routeSettings", + "documentation": "<p>Route settings for the stage, by routeKey.</p>" }, - "StageName" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stageName", - "documentation" : "<p>The name of the stage.</p>" + "StageName": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stageName", + "documentation": "<p>The name of the stage.</p>" }, - "StageVariables" : { - "shape" : "StageVariablesMap", - "locationName" : "stageVariables", - "documentation" : "<p>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" + "StageVariables": { + "shape": "StageVariablesMap", + "locationName": "stageVariables", + "documentation": "<p>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags. Each tag element is associated with a given resource.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags. Each tag element is associated with a given resource.</p>" } }, - "documentation" : "<p>Creates a new Stage resource to represent a stage.</p>", - "required" : [ "ApiId", "StageName" ] + "documentation": "<p>Creates a new Stage resource to represent a stage.</p>", + "required": [ + "ApiId", + "StageName" + ] }, - "CreateStageResponse" : { - "type" : "structure", - "members" : { - "AccessLogSettings" : { - "shape" : "AccessLogSettings", - "locationName" : "accessLogSettings", - "documentation" : "<p>Settings for logging access in this stage.</p>" + "CreateStageResponse": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "AccessLogSettings", + "locationName": "accessLogSettings", + "documentation": "<p>Settings for logging access in this stage.</p>" }, - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>" + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>" }, - "AutoDeploy" : { - "shape" : "__boolean", - "locationName" : "autoDeploy", - "documentation" : "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" + "AutoDeploy": { + "shape": "__boolean", + "locationName": "autoDeploy", + "documentation": "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" }, - "ClientCertificateId" : { - "shape" : "Id", - "locationName" : "clientCertificateId", - "documentation" : "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" + "ClientCertificateId": { + "shape": "Id", + "locationName": "clientCertificateId", + "documentation": "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the stage was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the stage was created.</p>" }, - "DefaultRouteSettings" : { - "shape" : "RouteSettings", - "locationName" : "defaultRouteSettings", - "documentation" : "<p>Default route settings for the stage.</p>" + "DefaultRouteSettings": { + "shape": "RouteSettings", + "locationName": "defaultRouteSettings", + "documentation": "<p>Default route settings for the stage.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the stage.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the stage.</p>" }, - "LastDeploymentStatusMessage" : { - "shape" : "__string", - "locationName" : "lastDeploymentStatusMessage", - "documentation" : "<p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>" + "LastDeploymentStatusMessage": { + "shape": "__string", + "locationName": "lastDeploymentStatusMessage", + "documentation": "<p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>" }, - "LastUpdatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "lastUpdatedDate", - "documentation" : "<p>The timestamp when the stage was last updated.</p>" + "LastUpdatedDate": { + "shape": "__timestampIso8601", + "locationName": "lastUpdatedDate", + "documentation": "<p>The timestamp when the stage was last updated.</p>" }, - "RouteSettings" : { - "shape" : "RouteSettingsMap", - "locationName" : "routeSettings", - "documentation" : "<p>Route settings for the stage, by routeKey.</p>" + "RouteSettings": { + "shape": "RouteSettingsMap", + "locationName": "routeSettings", + "documentation": "<p>Route settings for the stage, by routeKey.</p>" }, - "StageName" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stageName", - "documentation" : "<p>The name of the stage.</p>" + "StageName": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stageName", + "documentation": "<p>The name of the stage.</p>" }, - "StageVariables" : { - "shape" : "StageVariablesMap", - "locationName" : "stageVariables", - "documentation" : "<p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" + "StageVariables": { + "shape": "StageVariablesMap", + "locationName": "stageVariables", + "documentation": "<p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags. Each tag element is associated with a given resource.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags. Each tag element is associated with a given resource.</p>" } } }, - "CreateVpcLinkInput" : { - "type" : "structure", - "members" : { - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the VPC link.</p>" + "CreateVpcLinkInput": { + "type": "structure", + "members": { + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the VPC link.</p>" }, - "SecurityGroupIds" : { - "shape" : "SecurityGroupIdList", - "locationName" : "securityGroupIds", - "documentation" : "<p>A list of security group IDs for the VPC link.</p>" + "SecurityGroupIds": { + "shape": "SecurityGroupIdList", + "locationName": "securityGroupIds", + "documentation": "<p>A list of security group IDs for the VPC link.</p>" }, - "SubnetIds" : { - "shape" : "SubnetIdList", - "locationName" : "subnetIds", - "documentation" : "<p>A list of subnet IDs to include in the VPC link.</p>" + "SubnetIds": { + "shape": "SubnetIdList", + "locationName": "subnetIds", + "documentation": "<p>A list of subnet IDs to include in the VPC link.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>A list of tags.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>A list of tags.</p>" } }, - "documentation" : "<p>Represents the input parameters for a CreateVpcLink request.</p>", - "required" : [ "SubnetIds", "Name" ] + "documentation": "<p>Represents the input parameters for a CreateVpcLink request.</p>", + "required": [ + "SubnetIds", + "Name" + ] }, - "CreateVpcLinkRequest" : { - "type" : "structure", - "members" : { - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the VPC link.</p>" + "CreateVpcLinkRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the VPC link.</p>" }, - "SecurityGroupIds" : { - "shape" : "SecurityGroupIdList", - "locationName" : "securityGroupIds", - "documentation" : "<p>A list of security group IDs for the VPC link.</p>" + "SecurityGroupIds": { + "shape": "SecurityGroupIdList", + "locationName": "securityGroupIds", + "documentation": "<p>A list of security group IDs for the VPC link.</p>" }, - "SubnetIds" : { - "shape" : "SubnetIdList", - "locationName" : "subnetIds", - "documentation" : "<p>A list of subnet IDs to include in the VPC link.</p>" + "SubnetIds": { + "shape": "SubnetIdList", + "locationName": "subnetIds", + "documentation": "<p>A list of subnet IDs to include in the VPC link.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>A list of tags.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>A list of tags.</p>" } }, - "documentation" : "<p>Creates a VPC link</p>", - "required" : [ "SubnetIds", "Name" ] + "documentation": "<p>Creates a VPC link</p>", + "required": [ + "SubnetIds", + "Name" + ] }, - "CreateVpcLinkResponse" : { - "type" : "structure", - "members" : { - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the VPC link was created.</p>" + "CreateVpcLinkResponse": { + "type": "structure", + "members": { + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the VPC link was created.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the VPC link.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the VPC link.</p>" }, - "SecurityGroupIds" : { - "shape" : "SecurityGroupIdList", - "locationName" : "securityGroupIds", - "documentation" : "<p>A list of security group IDs for the VPC link.</p>" + "SecurityGroupIds": { + "shape": "SecurityGroupIdList", + "locationName": "securityGroupIds", + "documentation": "<p>A list of security group IDs for the VPC link.</p>" }, - "SubnetIds" : { - "shape" : "SubnetIdList", - "locationName" : "subnetIds", - "documentation" : "<p>A list of subnet IDs to include in the VPC link.</p>" + "SubnetIds": { + "shape": "SubnetIdList", + "locationName": "subnetIds", + "documentation": "<p>A list of subnet IDs to include in the VPC link.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>Tags for the VPC link.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>Tags for the VPC link.</p>" }, - "VpcLinkId" : { - "shape" : "Id", - "locationName" : "vpcLinkId", - "documentation" : "<p>The ID of the VPC link.</p>" + "VpcLinkId": { + "shape": "Id", + "locationName": "vpcLinkId", + "documentation": "<p>The ID of the VPC link.</p>" }, - "VpcLinkStatus" : { - "shape" : "VpcLinkStatus", - "locationName" : "vpcLinkStatus", - "documentation" : "<p>The status of the VPC link.</p>" + "VpcLinkStatus": { + "shape": "VpcLinkStatus", + "locationName": "vpcLinkStatus", + "documentation": "<p>The status of the VPC link.</p>" }, - "VpcLinkStatusMessage" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "vpcLinkStatusMessage", - "documentation" : "<p>A message summarizing the cause of the status of the VPC link.</p>" + "VpcLinkStatusMessage": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "vpcLinkStatusMessage", + "documentation": "<p>A message summarizing the cause of the status of the VPC link.</p>" }, - "VpcLinkVersion" : { - "shape" : "VpcLinkVersion", - "locationName" : "vpcLinkVersion", - "documentation" : "<p>The version of the VPC link.</p>" + "VpcLinkVersion": { + "shape": "VpcLinkVersion", + "locationName": "vpcLinkVersion", + "documentation": "<p>The version of the VPC link.</p>" } } }, - "DeleteAccessLogSettingsRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteAccessLogSettingsRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "StageName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "stageName", - "documentation" : "<p>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</p>" + "StageName": { + "shape": "__string", + "location": "uri", + "locationName": "stageName", + "documentation": "<p>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</p>" } }, - "required" : [ "StageName", "ApiId" ] + "required": [ + "StageName", + "ApiId" + ] }, - "DeleteApiMappingRequest" : { - "type" : "structure", - "members" : { - "ApiMappingId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiMappingId", - "documentation" : "<p>The API mapping identifier.</p>" + "DeleteApiMappingRequest": { + "type": "structure", + "members": { + "ApiMappingId": { + "shape": "__string", + "location": "uri", + "locationName": "apiMappingId", + "documentation": "<p>The API mapping identifier.</p>" }, - "DomainName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "domainName", - "documentation" : "<p>The domain name.</p>" + "DomainName": { + "shape": "__string", + "location": "uri", + "locationName": "domainName", + "documentation": "<p>The domain name.</p>" } }, - "required" : [ "ApiMappingId", "DomainName" ] + "required": [ + "ApiMappingId", + "DomainName" + ] }, - "DeleteApiRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteApiRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" } }, - "required" : [ "ApiId" ] + "required": [ + "ApiId" + ] }, - "DeleteAuthorizerRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteAuthorizerRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "AuthorizerId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "authorizerId", - "documentation" : "<p>The authorizer identifier.</p>" + "AuthorizerId": { + "shape": "__string", + "location": "uri", + "locationName": "authorizerId", + "documentation": "<p>The authorizer identifier.</p>" } }, - "required" : [ "AuthorizerId", "ApiId" ] + "required": [ + "AuthorizerId", + "ApiId" + ] }, - "DeleteCorsConfigurationRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteCorsConfigurationRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" } }, - "required" : [ "ApiId" ] + "required": [ + "ApiId" + ] }, - "DeleteDeploymentRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteDeploymentRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "DeploymentId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "deploymentId", - "documentation" : "<p>The deployment ID.</p>" + "DeploymentId": { + "shape": "__string", + "location": "uri", + "locationName": "deploymentId", + "documentation": "<p>The deployment ID.</p>" } }, - "required" : [ "ApiId", "DeploymentId" ] + "required": [ + "ApiId", + "DeploymentId" + ] }, - "DeleteDomainNameRequest" : { - "type" : "structure", - "members" : { - "DomainName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "domainName", - "documentation" : "<p>The domain name.</p>" + "DeleteDomainNameRequest": { + "type": "structure", + "members": { + "DomainName": { + "shape": "__string", + "location": "uri", + "locationName": "domainName", + "documentation": "<p>The domain name.</p>" } }, - "required" : [ "DomainName" ] + "required": [ + "DomainName" + ] }, - "DeleteIntegrationRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteIntegrationRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "IntegrationId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationId", - "documentation" : "<p>The integration ID.</p>" + "IntegrationId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationId", + "documentation": "<p>The integration ID.</p>" } }, - "required" : [ "ApiId", "IntegrationId" ] + "required": [ + "ApiId", + "IntegrationId" + ] }, - "DeleteIntegrationResponseRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteIntegrationResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "IntegrationId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationId", - "documentation" : "<p>The integration ID.</p>" + "IntegrationId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationId", + "documentation": "<p>The integration ID.</p>" }, - "IntegrationResponseId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationResponseId", - "documentation" : "<p>The integration response ID.</p>" + "IntegrationResponseId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationResponseId", + "documentation": "<p>The integration response ID.</p>" } }, - "required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ] + "required": [ + "ApiId", + "IntegrationResponseId", + "IntegrationId" + ] }, - "DeleteModelRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteModelRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ModelId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "modelId", - "documentation" : "<p>The model ID.</p>" + "ModelId": { + "shape": "__string", + "location": "uri", + "locationName": "modelId", + "documentation": "<p>The model ID.</p>" } }, - "required" : [ "ModelId", "ApiId" ] + "required": [ + "ModelId", + "ApiId" + ] }, - "DeleteRouteRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteRouteRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "RouteId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "__string", + "location": "uri", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" } }, - "required" : [ "ApiId", "RouteId" ] + "required": [ + "ApiId", + "RouteId" + ] }, - "DeleteRouteRequestParameterRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteRouteRequestParameterRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "RequestParameterKey" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "requestParameterKey", - "documentation" : "<p>The route request parameter key.</p>" + "RequestParameterKey": { + "shape": "__string", + "location": "uri", + "locationName": "requestParameterKey", + "documentation": "<p>The route request parameter key.</p>" }, - "RouteId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "__string", + "location": "uri", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" } }, - "required" : [ "RequestParameterKey", "ApiId", "RouteId" ] + "required": [ + "RequestParameterKey", + "ApiId", + "RouteId" + ] }, - "DeleteRouteResponseRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteRouteResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "RouteId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "__string", + "location": "uri", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" }, - "RouteResponseId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeResponseId", - "documentation" : "<p>The route response ID.</p>" + "RouteResponseId": { + "shape": "__string", + "location": "uri", + "locationName": "routeResponseId", + "documentation": "<p>The route response ID.</p>" } }, - "required" : [ "RouteResponseId", "ApiId", "RouteId" ] + "required": [ + "RouteResponseId", + "ApiId", + "RouteId" + ] }, - "DeleteRouteSettingsRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteRouteSettingsRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "RouteKey" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeKey", - "documentation" : "<p>The route key.</p>" + "RouteKey": { + "shape": "__string", + "location": "uri", + "locationName": "routeKey", + "documentation": "<p>The route key.</p>" }, - "StageName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "stageName", - "documentation" : "<p>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</p>" + "StageName": { + "shape": "__string", + "location": "uri", + "locationName": "stageName", + "documentation": "<p>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</p>" } }, - "required" : [ "StageName", "RouteKey", "ApiId" ] + "required": [ + "StageName", + "RouteKey", + "ApiId" + ] }, - "DeleteStageRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "DeleteStageRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "StageName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "stageName", - "documentation" : "<p>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</p>" + "StageName": { + "shape": "__string", + "location": "uri", + "locationName": "stageName", + "documentation": "<p>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</p>" } }, - "required" : [ "StageName", "ApiId" ] + "required": [ + "StageName", + "ApiId" + ] }, - "DeleteVpcLinkRequest" : { - "type" : "structure", - "members" : { - "VpcLinkId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "vpcLinkId", - "documentation" : "<p>The ID of the VPC link.</p>" + "DeleteVpcLinkRequest": { + "type": "structure", + "members": { + "VpcLinkId": { + "shape": "__string", + "location": "uri", + "locationName": "vpcLinkId", + "documentation": "<p>The ID of the VPC link.</p>" } }, - "required" : [ "VpcLinkId" ] + "required": [ + "VpcLinkId" + ] }, - "DeleteVpcLinkResponse" : { - "type" : "structure", - "members" : { } + "DeleteVpcLinkResponse": { + "type": "structure", + "members": { + } }, - "Deployment" : { - "type" : "structure", - "members" : { - "AutoDeployed" : { - "shape" : "__boolean", - "locationName" : "autoDeployed", - "documentation" : "<p>Specifies whether a deployment was automatically released.</p>" + "Deployment": { + "type": "structure", + "members": { + "AutoDeployed": { + "shape": "__boolean", + "locationName": "autoDeployed", + "documentation": "<p>Specifies whether a deployment was automatically released.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The date and time when the Deployment resource was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The date and time when the Deployment resource was created.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The identifier for the deployment.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The identifier for the deployment.</p>" }, - "DeploymentStatus" : { - "shape" : "DeploymentStatus", - "locationName" : "deploymentStatus", - "documentation" : "<p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>" + "DeploymentStatus": { + "shape": "DeploymentStatus", + "locationName": "deploymentStatus", + "documentation": "<p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>" }, - "DeploymentStatusMessage" : { - "shape" : "__string", - "locationName" : "deploymentStatusMessage", - "documentation" : "<p>May contain additional feedback on the status of an API deployment.</p>" + "DeploymentStatusMessage": { + "shape": "__string", + "locationName": "deploymentStatusMessage", + "documentation": "<p>May contain additional feedback on the status of an API deployment.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the deployment.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the deployment.</p>" } }, - "documentation" : "<p>An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.</p>" + "documentation": "<p>An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.</p>" }, - "DeploymentStatus" : { - "type" : "string", - "documentation" : "<p>Represents a deployment status.</p>", - "enum" : [ "PENDING", "FAILED", "DEPLOYED" ] + "DeploymentStatus": { + "type": "string", + "documentation": "<p>Represents a deployment status.</p>", + "enum": [ + "PENDING", + "FAILED", + "DEPLOYED" + ] }, - "Deployments" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfDeployment", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "Deployments": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfDeployment", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>A collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.</p>" + "documentation": "<p>A collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.</p>" }, - "DomainName" : { - "type" : "structure", - "members" : { - "ApiMappingSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiMappingSelectionExpression", - "documentation" : "<p>The API mapping selection expression.</p>" + "DomainName": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiMappingSelectionExpression", + "documentation": "<p>The API mapping selection expression.</p>" }, - "DomainName" : { - "shape" : "StringWithLengthBetween1And512", - "locationName" : "domainName", - "documentation" : "<p>The name of the DomainName resource.</p>" + "DomainName": { + "shape": "StringWithLengthBetween1And512", + "locationName": "domainName", + "documentation": "<p>The name of the DomainName resource.</p>" }, - "DomainNameConfigurations" : { - "shape" : "DomainNameConfigurations", - "locationName" : "domainNameConfigurations", - "documentation" : "<p>The domain name configurations.</p>" + "DomainNameConfigurations": { + "shape": "DomainNameConfigurations", + "locationName": "domainNameConfigurations", + "documentation": "<p>The domain name configurations.</p>" }, - "MutualTlsAuthentication" : { - "shape" : "MutualTlsAuthentication", - "locationName" : "mutualTlsAuthentication", - "documentation" : "<p>The mutual TLS authentication configuration for a custom domain name.</p>" + "MutualTlsAuthentication": { + "shape": "MutualTlsAuthentication", + "locationName": "mutualTlsAuthentication", + "documentation": "<p>The mutual TLS authentication configuration for a custom domain name.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags associated with a domain name.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags associated with a domain name.</p>" } }, - "documentation" : "<p>Represents a domain name.</p>", - "required" : [ "DomainName" ] + "documentation": "<p>Represents a domain name.</p>", + "required": [ + "DomainName" + ] }, - "DomainNameConfiguration" : { - "type" : "structure", - "members" : { - "ApiGatewayDomainName" : { - "shape" : "__string", - "locationName" : "apiGatewayDomainName", - "documentation" : "<p>A domain name for the API.</p>" + "DomainNameConfiguration": { + "type": "structure", + "members": { + "ApiGatewayDomainName": { + "shape": "__string", + "locationName": "apiGatewayDomainName", + "documentation": "<p>A domain name for the API.</p>" }, - "CertificateArn" : { - "shape" : "Arn", - "locationName" : "certificateArn", - "documentation" : "<p>An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>" + "CertificateArn": { + "shape": "Arn", + "locationName": "certificateArn", + "documentation": "<p>An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>" }, - "CertificateName" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "certificateName", - "documentation" : "<p>The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.</p>" + "CertificateName": { + "shape": "StringWithLengthBetween1And128", + "locationName": "certificateName", + "documentation": "<p>The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.</p>" }, - "CertificateUploadDate" : { - "shape" : "__timestampIso8601", - "locationName" : "certificateUploadDate", - "documentation" : "<p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.</p>" + "CertificateUploadDate": { + "shape": "__timestampIso8601", + "locationName": "certificateUploadDate", + "documentation": "<p>The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.</p>" }, - "DomainNameStatus" : { - "shape" : "DomainNameStatus", - "locationName" : "domainNameStatus", - "documentation" : "<p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>" + "DomainNameStatus": { + "shape": "DomainNameStatus", + "locationName": "domainNameStatus", + "documentation": "<p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>" }, - "DomainNameStatusMessage" : { - "shape" : "__string", - "locationName" : "domainNameStatusMessage", - "documentation" : "<p>An optional text message containing detailed information about status of the domain name migration.</p>" + "DomainNameStatusMessage": { + "shape": "__string", + "locationName": "domainNameStatusMessage", + "documentation": "<p>An optional text message containing detailed information about status of the domain name migration.</p>" }, - "EndpointType" : { - "shape" : "EndpointType", - "locationName" : "endpointType", - "documentation" : "<p>The endpoint type.</p>" + "EndpointType": { + "shape": "EndpointType", + "locationName": "endpointType", + "documentation": "<p>The endpoint type.</p>" }, - "HostedZoneId" : { - "shape" : "__string", - "locationName" : "hostedZoneId", - "documentation" : "<p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>" + "HostedZoneId": { + "shape": "__string", + "locationName": "hostedZoneId", + "documentation": "<p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>" }, - "SecurityPolicy" : { - "shape" : "SecurityPolicy", - "locationName" : "securityPolicy", - "documentation" : "<p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>" + "SecurityPolicy": { + "shape": "SecurityPolicy", + "locationName": "securityPolicy", + "documentation": "<p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>" }, - "OwnershipVerificationCertificateArn" : { - "shape" : "Arn", - "locationName" : "ownershipVerificationCertificateArn", - "documentation" : "<p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn</p>" + "OwnershipVerificationCertificateArn": { + "shape": "Arn", + "locationName": "ownershipVerificationCertificateArn", + "documentation": "<p>The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn</p>" } }, - "documentation" : "<p>The domain name configuration.</p>" + "documentation": "<p>The domain name configuration.</p>" }, - "DomainNameConfigurations" : { - "type" : "list", - "documentation" : "<p>The domain name configurations.</p>", - "member" : { - "shape" : "DomainNameConfiguration" + "DomainNameConfigurations": { + "type": "list", + "documentation": "<p>The domain name configurations.</p>", + "member": { + "shape": "DomainNameConfiguration" } }, - "DomainNameStatus" : { - "type" : "string", - "documentation" : "<p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>", - "enum" : [ "AVAILABLE", "UPDATING", "PENDING_CERTIFICATE_REIMPORT", "PENDING_OWNERSHIP_VERIFICATION" ] + "DomainNameStatus": { + "type": "string", + "documentation": "<p>The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>", + "enum": [ + "AVAILABLE", + "UPDATING", + "PENDING_CERTIFICATE_REIMPORT", + "PENDING_OWNERSHIP_VERIFICATION" + ] }, - "DomainNames" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfDomainName", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "DomainNames": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfDomainName", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>Represents a collection of domain names.</p>" + "documentation": "<p>Represents a collection of domain names.</p>" }, - "EndpointType" : { - "type" : "string", - "documentation" : "<p>Represents an endpoint type.</p>", - "enum" : [ "REGIONAL", "EDGE" ] + "EndpointType": { + "type": "string", + "documentation": "<p>Represents an endpoint type.</p>", + "enum": [ + "REGIONAL", + "EDGE" + ] }, - "ExportApiRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "ExportApiRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ExportVersion" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "exportVersion", - "documentation" : "<p>The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.</p>" + "ExportVersion": { + "shape": "__string", + "location": "querystring", + "locationName": "exportVersion", + "documentation": "<p>The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.</p>" }, - "IncludeExtensions" : { - "shape" : "__boolean", - "location" : "querystring", - "locationName" : "includeExtensions", - "documentation" : "<p>Specifies whether to include <a href=\"https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html\">API Gateway extensions</a> in the exported API definition. API Gateway extensions are included by default.</p>" + "IncludeExtensions": { + "shape": "__boolean", + "location": "querystring", + "locationName": "includeExtensions", + "documentation": "<p>Specifies whether to include <a href=\"https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html\">API Gateway extensions</a> in the exported API definition. API Gateway extensions are included by default.</p>" }, - "OutputType" : { - "shape" : "__string", - "enum" : ["YAML", "JSON"], - "location" : "querystring", - "locationName" : "outputType", - "documentation" : "<p>The output type of the exported definition file. Valid values are JSON and YAML.</p>" + "OutputType": { + "shape": "__string", + "enum": [ + "YAML", + "JSON" + ], + "location": "querystring", + "locationName": "outputType", + "documentation": "<p>The output type of the exported definition file. Valid values are JSON and YAML.</p>" }, - "Specification" : { - "shape" : "__string", - "enum" : ["OAS30"], - "location" : "uri", - "locationName" : "specification", - "documentation" : "<p>The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.</p>" + "Specification": { + "shape": "__string", + "enum": [ + "OAS30" + ], + "location": "uri", + "locationName": "specification", + "documentation": "<p>The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.</p>" }, - "StageName" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "stageName", - "documentation" : "<p>The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.</p>" + "StageName": { + "shape": "__string", + "location": "querystring", + "locationName": "stageName", + "documentation": "<p>The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.</p>" } }, - "required" : [ "Specification", "OutputType", "ApiId" ] + "required": [ + "Specification", + "OutputType", + "ApiId" + ] }, - "ExportApiResponse" : { - "type" : "structure", - "members" : { - "body":{ - "shape":"ExportedApi" + "ExportApiResponse": { + "type": "structure", + "members": { + "body": { + "shape": "ExportedApi" } }, - "payload":"body" + "payload": "body" }, - "ExportedApi":{ - "type":"blob", - "documentation" : "<p>Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.</p>" + "ExportedApi": { + "type": "blob", + "documentation": "<p>Represents an exported definition of an API in a particular output format, for example, YAML. The API is serialized to the requested specification, for example, OpenAPI 3.0.</p>" }, - "ResetAuthorizersCacheRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "ResetAuthorizersCacheRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "StageName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "stageName", - "documentation" : "<p>The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.</p>" + "StageName": { + "shape": "__string", + "location": "uri", + "locationName": "stageName", + "documentation": "<p>The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.</p>" } }, - "required" : [ "StageName", "ApiId" ] + "required": [ + "StageName", + "ApiId" + ] }, - "GetApiMappingRequest" : { - "type" : "structure", - "members" : { - "ApiMappingId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiMappingId", - "documentation" : "<p>The API mapping identifier.</p>" + "GetApiMappingRequest": { + "type": "structure", + "members": { + "ApiMappingId": { + "shape": "__string", + "location": "uri", + "locationName": "apiMappingId", + "documentation": "<p>The API mapping identifier.</p>" }, - "DomainName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "domainName", - "documentation" : "<p>The domain name.</p>" + "DomainName": { + "shape": "__string", + "location": "uri", + "locationName": "domainName", + "documentation": "<p>The domain name.</p>" } }, - "required" : [ "ApiMappingId", "DomainName" ] + "required": [ + "ApiMappingId", + "DomainName" + ] }, - "GetApiMappingResponse" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetApiMappingResponse": { + "type": "structure", + "members": { + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiMappingId" : { - "shape" : "Id", - "locationName" : "apiMappingId", - "documentation" : "<p>The API mapping identifier.</p>" + "ApiMappingId": { + "shape": "Id", + "locationName": "apiMappingId", + "documentation": "<p>The API mapping identifier.</p>" }, - "ApiMappingKey" : { - "shape" : "SelectionKey", - "locationName" : "apiMappingKey", - "documentation" : "<p>The API mapping key.</p>" + "ApiMappingKey": { + "shape": "SelectionKey", + "locationName": "apiMappingKey", + "documentation": "<p>The API mapping key.</p>" }, - "Stage" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stage", - "documentation" : "<p>The API stage.</p>" + "Stage": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stage", + "documentation": "<p>The API stage.</p>" } } }, - "GetApiMappingsRequest" : { - "type" : "structure", - "members" : { - "DomainName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "domainName", - "documentation" : "<p>The domain name.</p>" + "GetApiMappingsRequest": { + "type": "structure", + "members": { + "DomainName": { + "shape": "__string", + "location": "uri", + "locationName": "domainName", + "documentation": "<p>The domain name.</p>" }, - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "required" : [ "DomainName" ] + "required": [ + "DomainName" + ] }, - "GetApiMappingsResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfApiMapping", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetApiMappingsResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfApiMapping", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetApiRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetApiRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" } }, - "required" : [ "ApiId" ] + "required": [ + "ApiId" + ] }, - "GetApiResponse" : { - "type" : "structure", - "members" : { - "ApiEndpoint" : { - "shape" : "__string", - "locationName" : "apiEndpoint", - "documentation" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" + "GetApiResponse": { + "type": "structure", + "members": { + "ApiEndpoint": { + "shape": "__string", + "locationName": "apiEndpoint", + "documentation": "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" }, - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" }, - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API ID.</p>" + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API ID.</p>" }, - "ApiKeySelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiKeySelectionExpression", - "documentation" : "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" + "ApiKeySelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiKeySelectionExpression", + "documentation": "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" }, - "CorsConfiguration" : { - "shape" : "Cors", - "locationName" : "corsConfiguration", - "documentation" : "<p>A CORS configuration. Supported only for HTTP APIs.</p>" + "CorsConfiguration": { + "shape": "Cors", + "locationName": "corsConfiguration", + "documentation": "<p>A CORS configuration. Supported only for HTTP APIs.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the API was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the API was created.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the API.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the API.</p>" }, - "DisableSchemaValidation" : { - "shape" : "__boolean", - "locationName" : "disableSchemaValidation", - "documentation" : "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" + "DisableSchemaValidation": { + "shape": "__boolean", + "locationName": "disableSchemaValidation", + "documentation": "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" }, - "DisableExecuteApiEndpoint" : { - "shape" : "__boolean", - "locationName" : "disableExecuteApiEndpoint", - "documentation" : "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" + "DisableExecuteApiEndpoint": { + "shape": "__boolean", + "locationName": "disableExecuteApiEndpoint", + "documentation": "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" }, - "ImportInfo" : { - "shape" : "__listOf__string", - "locationName" : "importInfo", - "documentation" : "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" + "ImportInfo": { + "shape": "__listOf__string", + "locationName": "importInfo", + "documentation": "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the API.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the API.</p>" }, - "ProtocolType" : { - "shape" : "ProtocolType", - "locationName" : "protocolType", - "documentation" : "<p>The API protocol.</p>" + "ProtocolType": { + "shape": "ProtocolType", + "locationName": "protocolType", + "documentation": "<p>The API protocol.</p>" }, - "RouteSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeSelectionExpression", - "documentation" : "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" + "RouteSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeSelectionExpression", + "documentation": "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>A collection of tags associated with the API.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>A collection of tags associated with the API.</p>" }, - "Version" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "version", - "documentation" : "<p>A version identifier for the API.</p>" + "Version": { + "shape": "StringWithLengthBetween1And64", + "locationName": "version", + "documentation": "<p>A version identifier for the API.</p>" }, - "Warnings" : { - "shape" : "__listOf__string", - "locationName" : "warnings", - "documentation" : "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" + "Warnings": { + "shape": "__listOf__string", + "locationName": "warnings", + "documentation": "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" } } }, - "GetApisRequest" : { - "type" : "structure", - "members" : { - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "GetApisRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetApisResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfApi", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetApisResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfApi", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetAuthorizerRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetAuthorizerRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "AuthorizerId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "authorizerId", - "documentation" : "<p>The authorizer identifier.</p>" + "AuthorizerId": { + "shape": "__string", + "location": "uri", + "locationName": "authorizerId", + "documentation": "<p>The authorizer identifier.</p>" } }, - "required" : [ "AuthorizerId", "ApiId" ] + "required": [ + "AuthorizerId", + "ApiId" + ] }, - "GetAuthorizerResponse" : { - "type" : "structure", - "members" : { - "AuthorizerCredentialsArn" : { - "shape" : "Arn", - "locationName" : "authorizerCredentialsArn", - "documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" + "GetAuthorizerResponse": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "shape": "Arn", + "locationName": "authorizerCredentialsArn", + "documentation": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The authorizer identifier.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The authorizer identifier.</p>" }, - "AuthorizerPayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "authorizerPayloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" + "AuthorizerPayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "authorizerPayloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" }, - "AuthorizerResultTtlInSeconds" : { - "shape" : "IntegerWithLengthBetween0And3600", - "locationName" : "authorizerResultTtlInSeconds", - "documentation" : "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" + "AuthorizerResultTtlInSeconds": { + "shape": "IntegerWithLengthBetween0And3600", + "locationName": "authorizerResultTtlInSeconds", + "documentation": "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" }, - "AuthorizerType" : { - "shape" : "AuthorizerType", - "locationName" : "authorizerType", - "documentation" : "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" + "AuthorizerType": { + "shape": "AuthorizerType", + "locationName": "authorizerType", + "documentation": "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" }, - "AuthorizerUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "authorizerUri", - "documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" + "AuthorizerUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "authorizerUri", + "documentation": "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" }, - "EnableSimpleResponses" : { - "shape" : "__boolean", - "locationName" : "enableSimpleResponses", - "documentation" : "<p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" + "EnableSimpleResponses": { + "shape": "__boolean", + "locationName": "enableSimpleResponses", + "documentation": "<p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" }, - "IdentitySource" : { - "shape" : "IdentitySourceList", - "locationName" : "identitySource", - "documentation" : "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" + "IdentitySource": { + "shape": "IdentitySourceList", + "locationName": "identitySource", + "documentation": "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" }, - "IdentityValidationExpression" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "identityValidationExpression", - "documentation" : "<p>The validation expression does not apply to the REQUEST authorizer.</p>" + "IdentityValidationExpression": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "identityValidationExpression", + "documentation": "<p>The validation expression does not apply to the REQUEST authorizer.</p>" }, - "JwtConfiguration" : { - "shape" : "JWTConfiguration", - "locationName" : "jwtConfiguration", - "documentation" : "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" + "JwtConfiguration": { + "shape": "JWTConfiguration", + "locationName": "jwtConfiguration", + "documentation": "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the authorizer.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the authorizer.</p>" } } }, - "GetAuthorizersRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetAuthorizersRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "required" : [ "ApiId" ] + "required": [ + "ApiId" + ] }, - "GetAuthorizersResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfAuthorizer", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetAuthorizersResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfAuthorizer", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetDeploymentRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetDeploymentRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "DeploymentId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "deploymentId", - "documentation" : "<p>The deployment ID.</p>" + "DeploymentId": { + "shape": "__string", + "location": "uri", + "locationName": "deploymentId", + "documentation": "<p>The deployment ID.</p>" } }, - "required" : [ "ApiId", "DeploymentId" ] + "required": [ + "ApiId", + "DeploymentId" + ] }, - "GetDeploymentResponse" : { - "type" : "structure", - "members" : { - "AutoDeployed" : { - "shape" : "__boolean", - "locationName" : "autoDeployed", - "documentation" : "<p>Specifies whether a deployment was automatically released.</p>" + "GetDeploymentResponse": { + "type": "structure", + "members": { + "AutoDeployed": { + "shape": "__boolean", + "locationName": "autoDeployed", + "documentation": "<p>Specifies whether a deployment was automatically released.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The date and time when the Deployment resource was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The date and time when the Deployment resource was created.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The identifier for the deployment.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The identifier for the deployment.</p>" }, - "DeploymentStatus" : { - "shape" : "DeploymentStatus", - "locationName" : "deploymentStatus", - "documentation" : "<p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>" + "DeploymentStatus": { + "shape": "DeploymentStatus", + "locationName": "deploymentStatus", + "documentation": "<p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>" }, - "DeploymentStatusMessage" : { - "shape" : "__string", - "locationName" : "deploymentStatusMessage", - "documentation" : "<p>May contain additional feedback on the status of an API deployment.</p>" + "DeploymentStatusMessage": { + "shape": "__string", + "locationName": "deploymentStatusMessage", + "documentation": "<p>May contain additional feedback on the status of an API deployment.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the deployment.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the deployment.</p>" } } }, - "GetDeploymentsRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetDeploymentsRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "required" : [ "ApiId" ] + "required": [ + "ApiId" + ] }, - "GetDeploymentsResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfDeployment", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetDeploymentsResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfDeployment", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetDomainNameRequest" : { - "type" : "structure", - "members" : { - "DomainName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "domainName", - "documentation" : "<p>The domain name.</p>" + "GetDomainNameRequest": { + "type": "structure", + "members": { + "DomainName": { + "shape": "__string", + "location": "uri", + "locationName": "domainName", + "documentation": "<p>The domain name.</p>" } }, - "required" : [ "DomainName" ] + "required": [ + "DomainName" + ] }, - "GetDomainNameResponse" : { - "type" : "structure", - "members" : { - "ApiMappingSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiMappingSelectionExpression", - "documentation" : "<p>The API mapping selection expression.</p>" + "GetDomainNameResponse": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiMappingSelectionExpression", + "documentation": "<p>The API mapping selection expression.</p>" }, - "DomainName" : { - "shape" : "StringWithLengthBetween1And512", - "locationName" : "domainName", - "documentation" : "<p>The name of the DomainName resource.</p>" + "DomainName": { + "shape": "StringWithLengthBetween1And512", + "locationName": "domainName", + "documentation": "<p>The name of the DomainName resource.</p>" }, - "DomainNameConfigurations" : { - "shape" : "DomainNameConfigurations", - "locationName" : "domainNameConfigurations", - "documentation" : "<p>The domain name configurations.</p>" + "DomainNameConfigurations": { + "shape": "DomainNameConfigurations", + "locationName": "domainNameConfigurations", + "documentation": "<p>The domain name configurations.</p>" }, - "MutualTlsAuthentication" : { - "shape" : "MutualTlsAuthentication", - "locationName" : "mutualTlsAuthentication", - "documentation" : "<p>The mutual TLS authentication configuration for a custom domain name.</p>" + "MutualTlsAuthentication": { + "shape": "MutualTlsAuthentication", + "locationName": "mutualTlsAuthentication", + "documentation": "<p>The mutual TLS authentication configuration for a custom domain name.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags associated with a domain name.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags associated with a domain name.</p>" } } }, - "GetDomainNamesRequest" : { - "type" : "structure", - "members" : { - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "GetDomainNamesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetDomainNamesResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfDomainName", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetDomainNamesResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfDomainName", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetIntegrationRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetIntegrationRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "IntegrationId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationId", - "documentation" : "<p>The integration ID.</p>" + "IntegrationId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationId", + "documentation": "<p>The integration ID.</p>" } }, - "required" : [ "ApiId", "IntegrationId" ] + "required": [ + "ApiId", + "IntegrationId" + ] }, - "GetIntegrationResult" : { - "type" : "structure", - "members" : { - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>" + "GetIntegrationResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>" }, - "ConnectionId" : { - "shape" : "StringWithLengthBetween1And1024", - "locationName" : "connectionId", - "documentation" : "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" + "ConnectionId": { + "shape": "StringWithLengthBetween1And1024", + "locationName": "connectionId", + "documentation": "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" }, - "ConnectionType" : { - "shape" : "ConnectionType", - "locationName" : "connectionType", - "documentation" : "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" + "ConnectionType": { + "shape": "ConnectionType", + "locationName": "connectionType", + "documentation": "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" }, - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>Represents the description of an integration.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>Represents the description of an integration.</p>" }, - "IntegrationId" : { - "shape" : "Id", - "locationName" : "integrationId", - "documentation" : "<p>Represents the identifier of an integration.</p>" + "IntegrationId": { + "shape": "Id", + "locationName": "integrationId", + "documentation": "<p>Represents the identifier of an integration.</p>" }, - "IntegrationMethod" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "integrationMethod", - "documentation" : "<p>Specifies the integration's HTTP method type.</p>" + "IntegrationMethod": { + "shape": "StringWithLengthBetween1And64", + "locationName": "integrationMethod", + "documentation": "<p>Specifies the integration's HTTP method type.</p>" }, - "IntegrationResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "integrationResponseSelectionExpression", - "documentation" : "<p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>" + "IntegrationResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "integrationResponseSelectionExpression", + "documentation": "<p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>" }, - "IntegrationSubtype" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "integrationSubtype", - "documentation" : "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" + "IntegrationSubtype": { + "shape": "StringWithLengthBetween1And128", + "locationName": "integrationSubtype", + "documentation": "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" }, - "IntegrationType" : { - "shape" : "IntegrationType", - "locationName" : "integrationType", - "documentation" : "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" + "IntegrationType": { + "shape": "IntegrationType", + "locationName": "integrationType", + "documentation": "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" }, - "IntegrationUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "integrationUri", - "documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" + "IntegrationUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "integrationUri", + "documentation": "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" }, - "PassthroughBehavior" : { - "shape" : "PassthroughBehavior", - "locationName" : "passthroughBehavior", - "documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" + "PassthroughBehavior": { + "shape": "PassthroughBehavior", + "locationName": "passthroughBehavior", + "documentation": "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" }, - "PayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "payloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>" + "PayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "payloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>" }, - "RequestParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "requestParameters", - "documentation" : "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "RequestParameters": { + "shape": "IntegrationParameters", + "locationName": "requestParameters", + "documentation": "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "RequestTemplates" : { - "shape" : "TemplateMap", - "locationName" : "requestTemplates", - "documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" + "RequestTemplates": { + "shape": "TemplateMap", + "locationName": "requestTemplates", + "documentation": "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" }, - "ResponseParameters" : { - "shape" : "ResponseParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "ResponseParameters": { + "shape": "ResponseParameters", + "locationName": "responseParameters", + "documentation": "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>" }, - "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And30000", - "locationName" : "timeoutInMillis", - "documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" + "TimeoutInMillis": { + "shape": "IntegerWithLengthBetween50And30000", + "locationName": "timeoutInMillis", + "documentation": "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" }, - "TlsConfig" : { - "shape" : "TlsConfig", - "locationName" : "tlsConfig", - "documentation" : "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" + "TlsConfig": { + "shape": "TlsConfig", + "locationName": "tlsConfig", + "documentation": "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" } } }, - "GetIntegrationResponseRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetIntegrationResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "IntegrationId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationId", - "documentation" : "<p>The integration ID.</p>" + "IntegrationId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationId", + "documentation": "<p>The integration ID.</p>" }, - "IntegrationResponseId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationResponseId", - "documentation" : "<p>The integration response ID.</p>" + "IntegrationResponseId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationResponseId", + "documentation": "<p>The integration response ID.</p>" } }, - "required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ] + "required": [ + "ApiId", + "IntegrationResponseId", + "IntegrationId" + ] }, - "GetIntegrationResponseResponse" : { - "type" : "structure", - "members" : { - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "GetIntegrationResponseResponse": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "IntegrationResponseId" : { - "shape" : "Id", - "locationName" : "integrationResponseId", - "documentation" : "<p>The integration response ID.</p>" + "IntegrationResponseId": { + "shape": "Id", + "locationName": "integrationResponseId", + "documentation": "<p>The integration response ID.</p>" }, - "IntegrationResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "integrationResponseKey", - "documentation" : "<p>The integration response key.</p>" + "IntegrationResponseKey": { + "shape": "SelectionKey", + "locationName": "integrationResponseKey", + "documentation": "<p>The integration response key.</p>" }, - "ResponseParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "responseParameters", - "documentation" : "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>" + "ResponseParameters": { + "shape": "IntegrationParameters", + "locationName": "responseParameters", + "documentation": "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>" }, - "ResponseTemplates" : { - "shape" : "TemplateMap", - "locationName" : "responseTemplates", - "documentation" : "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" + "ResponseTemplates": { + "shape": "TemplateMap", + "locationName": "responseTemplates", + "documentation": "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expressions for the integration response.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expressions for the integration response.</p>" } } }, - "GetIntegrationResponsesRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetIntegrationResponsesRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "IntegrationId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationId", - "documentation" : "<p>The integration ID.</p>" + "IntegrationId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationId", + "documentation": "<p>The integration ID.</p>" }, - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "required" : [ "IntegrationId", "ApiId" ] + "required": [ + "IntegrationId", + "ApiId" + ] }, - "GetIntegrationResponsesResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfIntegrationResponse", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetIntegrationResponsesResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfIntegrationResponse", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetIntegrationsRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetIntegrationsRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "required" : [ "ApiId" ] + "required": [ + "ApiId" + ] }, - "GetIntegrationsResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfIntegration", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetIntegrationsResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfIntegration", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetModelRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetModelRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ModelId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "modelId", - "documentation" : "<p>The model ID.</p>" + "ModelId": { + "shape": "__string", + "location": "uri", + "locationName": "modelId", + "documentation": "<p>The model ID.</p>" } }, - "required" : [ "ModelId", "ApiId" ] + "required": [ + "ModelId", + "ApiId" + ] }, - "GetModelResponse" : { - "type" : "structure", - "members" : { - "ContentType" : { - "shape" : "StringWithLengthBetween1And256", - "locationName" : "contentType", - "documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>" + "GetModelResponse": { + "type": "structure", + "members": { + "ContentType": { + "shape": "StringWithLengthBetween1And256", + "locationName": "contentType", + "documentation": "<p>The content-type for the model, for example, \"application/json\".</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the model.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the model.</p>" }, - "ModelId" : { - "shape" : "Id", - "locationName" : "modelId", - "documentation" : "<p>The model identifier.</p>" + "ModelId": { + "shape": "Id", + "locationName": "modelId", + "documentation": "<p>The model identifier.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the model. Must be alphanumeric.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the model. Must be alphanumeric.</p>" }, - "Schema" : { - "shape" : "StringWithLengthBetween0And32K", - "locationName" : "schema", - "documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" + "Schema": { + "shape": "StringWithLengthBetween0And32K", + "locationName": "schema", + "documentation": "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" } } }, - "GetModelTemplateRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetModelTemplateRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ModelId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "modelId", - "documentation" : "<p>The model ID.</p>" + "ModelId": { + "shape": "__string", + "location": "uri", + "locationName": "modelId", + "documentation": "<p>The model ID.</p>" } }, - "required" : [ "ModelId", "ApiId" ] + "required": [ + "ModelId", + "ApiId" + ] }, - "GetModelTemplateResponse" : { - "type" : "structure", - "members" : { - "Value" : { - "shape" : "__string", - "locationName" : "value", - "documentation" : "<p>The template value.</p>" + "GetModelTemplateResponse": { + "type": "structure", + "members": { + "Value": { + "shape": "__string", + "locationName": "value", + "documentation": "<p>The template value.</p>" } } }, - "GetModelsRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetModelsRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "required" : [ "ApiId" ] + "required": [ + "ApiId" + ] }, - "GetModelsResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfModel", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetModelsResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfModel", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetRouteRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetRouteRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "RouteId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "__string", + "location": "uri", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" } }, - "required" : [ "ApiId", "RouteId" ] + "required": [ + "ApiId", + "RouteId" + ] }, - "GetRouteResult" : { - "type" : "structure", - "members" : { - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>" + "GetRouteResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>" }, - "ApiKeyRequired" : { - "shape" : "__boolean", - "locationName" : "apiKeyRequired", - "documentation" : "<p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>" + "ApiKeyRequired": { + "shape": "__boolean", + "locationName": "apiKeyRequired", + "documentation": "<p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>" }, - "AuthorizationScopes" : { - "shape" : "AuthorizationScopes", - "locationName" : "authorizationScopes", - "documentation" : "<p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>" + "AuthorizationScopes": { + "shape": "AuthorizationScopes", + "locationName": "authorizationScopes", + "documentation": "<p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>" }, - "AuthorizationType" : { - "shape" : "AuthorizationType", - "locationName" : "authorizationType", - "documentation" : "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" + "AuthorizationType": { + "shape": "AuthorizationType", + "locationName": "authorizationType", + "documentation": "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" }, - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "OperationName" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "operationName", - "documentation" : "<p>The operation name for the route.</p>" + "OperationName": { + "shape": "StringWithLengthBetween1And64", + "locationName": "operationName", + "documentation": "<p>The operation name for the route.</p>" }, - "RequestModels" : { - "shape" : "RouteModels", - "locationName" : "requestModels", - "documentation" : "<p>The request models for the route. Supported only for WebSocket APIs.</p>" + "RequestModels": { + "shape": "RouteModels", + "locationName": "requestModels", + "documentation": "<p>The request models for the route. Supported only for WebSocket APIs.</p>" }, - "RequestParameters" : { - "shape" : "RouteParameters", - "locationName" : "requestParameters", - "documentation" : "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" + "RequestParameters": { + "shape": "RouteParameters", + "locationName": "requestParameters", + "documentation": "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" }, - "RouteId" : { - "shape" : "Id", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "Id", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>The route key for the route.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>The route key for the route.</p>" }, - "RouteResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeResponseSelectionExpression", - "documentation" : "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" + "RouteResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeResponseSelectionExpression", + "documentation": "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "Target" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "target", - "documentation" : "<p>The target for the route.</p>" + "Target": { + "shape": "StringWithLengthBetween1And128", + "locationName": "target", + "documentation": "<p>The target for the route.</p>" } } }, - "GetRouteResponseRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetRouteResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "RouteId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "__string", + "location": "uri", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" }, - "RouteResponseId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeResponseId", - "documentation" : "<p>The route response ID.</p>" + "RouteResponseId": { + "shape": "__string", + "location": "uri", + "locationName": "routeResponseId", + "documentation": "<p>The route response ID.</p>" } }, - "required" : [ "RouteResponseId", "ApiId", "RouteId" ] + "required": [ + "RouteResponseId", + "ApiId", + "RouteId" + ] }, - "GetRouteResponseResponse" : { - "type" : "structure", - "members" : { - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>" + "GetRouteResponseResponse": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>" }, - "ResponseModels" : { - "shape" : "RouteModels", - "locationName" : "responseModels", - "documentation" : "<p>Represents the response models of a route response.</p>" + "ResponseModels": { + "shape": "RouteModels", + "locationName": "responseModels", + "documentation": "<p>Represents the response models of a route response.</p>" }, - "ResponseParameters" : { - "shape" : "RouteParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Represents the response parameters of a route response.</p>" + "ResponseParameters": { + "shape": "RouteParameters", + "locationName": "responseParameters", + "documentation": "<p>Represents the response parameters of a route response.</p>" }, - "RouteResponseId" : { - "shape" : "Id", - "locationName" : "routeResponseId", - "documentation" : "<p>Represents the identifier of a route response.</p>" + "RouteResponseId": { + "shape": "Id", + "locationName": "routeResponseId", + "documentation": "<p>Represents the identifier of a route response.</p>" }, - "RouteResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "routeResponseKey", - "documentation" : "<p>Represents the route response key of a route response.</p>" + "RouteResponseKey": { + "shape": "SelectionKey", + "locationName": "routeResponseKey", + "documentation": "<p>Represents the route response key of a route response.</p>" } } }, - "GetRouteResponsesRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetRouteResponsesRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" }, - "RouteId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "__string", + "location": "uri", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" } }, - "required" : [ "RouteId", "ApiId" ] + "required": [ + "RouteId", + "ApiId" + ] }, - "GetRouteResponsesResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfRouteResponse", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetRouteResponsesResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfRouteResponse", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetRoutesRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetRoutesRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "required" : [ "ApiId" ] + "required": [ + "ApiId" + ] }, - "GetRoutesResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfRoute", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetRoutesResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfRoute", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetStageRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetStageRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "StageName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "stageName", - "documentation" : "<p>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</p>" + "StageName": { + "shape": "__string", + "location": "uri", + "locationName": "stageName", + "documentation": "<p>The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.</p>" } }, - "required" : [ "StageName", "ApiId" ] + "required": [ + "StageName", + "ApiId" + ] }, - "GetStageResponse" : { - "type" : "structure", - "members" : { - "AccessLogSettings" : { - "shape" : "AccessLogSettings", - "locationName" : "accessLogSettings", - "documentation" : "<p>Settings for logging access in this stage.</p>" + "GetStageResponse": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "AccessLogSettings", + "locationName": "accessLogSettings", + "documentation": "<p>Settings for logging access in this stage.</p>" }, - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>" + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>" }, - "AutoDeploy" : { - "shape" : "__boolean", - "locationName" : "autoDeploy", - "documentation" : "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" + "AutoDeploy": { + "shape": "__boolean", + "locationName": "autoDeploy", + "documentation": "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" }, - "ClientCertificateId" : { - "shape" : "Id", - "locationName" : "clientCertificateId", - "documentation" : "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" + "ClientCertificateId": { + "shape": "Id", + "locationName": "clientCertificateId", + "documentation": "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the stage was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the stage was created.</p>" }, - "DefaultRouteSettings" : { - "shape" : "RouteSettings", - "locationName" : "defaultRouteSettings", - "documentation" : "<p>Default route settings for the stage.</p>" + "DefaultRouteSettings": { + "shape": "RouteSettings", + "locationName": "defaultRouteSettings", + "documentation": "<p>Default route settings for the stage.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the stage.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the stage.</p>" }, - "LastDeploymentStatusMessage" : { - "shape" : "__string", - "locationName" : "lastDeploymentStatusMessage", - "documentation" : "<p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>" + "LastDeploymentStatusMessage": { + "shape": "__string", + "locationName": "lastDeploymentStatusMessage", + "documentation": "<p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>" }, - "LastUpdatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "lastUpdatedDate", - "documentation" : "<p>The timestamp when the stage was last updated.</p>" + "LastUpdatedDate": { + "shape": "__timestampIso8601", + "locationName": "lastUpdatedDate", + "documentation": "<p>The timestamp when the stage was last updated.</p>" }, - "RouteSettings" : { - "shape" : "RouteSettingsMap", - "locationName" : "routeSettings", - "documentation" : "<p>Route settings for the stage, by routeKey.</p>" + "RouteSettings": { + "shape": "RouteSettingsMap", + "locationName": "routeSettings", + "documentation": "<p>Route settings for the stage, by routeKey.</p>" }, - "StageName" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stageName", - "documentation" : "<p>The name of the stage.</p>" + "StageName": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stageName", + "documentation": "<p>The name of the stage.</p>" }, - "StageVariables" : { - "shape" : "StageVariablesMap", - "locationName" : "stageVariables", - "documentation" : "<p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" + "StageVariables": { + "shape": "StageVariablesMap", + "locationName": "stageVariables", + "documentation": "<p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags. Each tag element is associated with a given resource.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags. Each tag element is associated with a given resource.</p>" } } }, - "GetStagesRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "GetStagesRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "required" : [ "ApiId" ] + "required": [ + "ApiId" + ] }, - "GetStagesResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfStage", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "GetStagesResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfStage", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetTagsRequest" : { - "type" : "structure", - "members" : { - "ResourceArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "resource-arn", - "documentation" : "<p>The resource ARN for the tag.</p>" + "GetTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn", + "documentation": "<p>The resource ARN for the tag.</p>" } }, - "required" : [ "ResourceArn" ] + "required": [ + "ResourceArn" + ] }, - "GetTagsResponse" : { - "type" : "structure", - "members" : { - "Tags" : { - "shape" : "Tags", + "GetTagsResponse": { + "type": "structure", + "members": { + "Tags": { + "shape": "Tags", "locationName": "tags" } } }, - "GetVpcLinkRequest" : { - "type" : "structure", - "members" : { - "VpcLinkId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "vpcLinkId", - "documentation" : "<p>The ID of the VPC link.</p>" + "GetVpcLinkRequest": { + "type": "structure", + "members": { + "VpcLinkId": { + "shape": "__string", + "location": "uri", + "locationName": "vpcLinkId", + "documentation": "<p>The ID of the VPC link.</p>" } }, - "required" : [ "VpcLinkId" ] + "required": [ + "VpcLinkId" + ] }, - "GetVpcLinkResponse" : { - "type" : "structure", - "members" : { - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the VPC link was created.</p>" + "GetVpcLinkResponse": { + "type": "structure", + "members": { + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the VPC link was created.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the VPC link.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the VPC link.</p>" }, - "SecurityGroupIds" : { - "shape" : "SecurityGroupIdList", - "locationName" : "securityGroupIds", - "documentation" : "<p>A list of security group IDs for the VPC link.</p>" + "SecurityGroupIds": { + "shape": "SecurityGroupIdList", + "locationName": "securityGroupIds", + "documentation": "<p>A list of security group IDs for the VPC link.</p>" }, - "SubnetIds" : { - "shape" : "SubnetIdList", - "locationName" : "subnetIds", - "documentation" : "<p>A list of subnet IDs to include in the VPC link.</p>" + "SubnetIds": { + "shape": "SubnetIdList", + "locationName": "subnetIds", + "documentation": "<p>A list of subnet IDs to include in the VPC link.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>Tags for the VPC link.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>Tags for the VPC link.</p>" }, - "VpcLinkId" : { - "shape" : "Id", - "locationName" : "vpcLinkId", - "documentation" : "<p>The ID of the VPC link.</p>" + "VpcLinkId": { + "shape": "Id", + "locationName": "vpcLinkId", + "documentation": "<p>The ID of the VPC link.</p>" }, - "VpcLinkStatus" : { - "shape" : "VpcLinkStatus", - "locationName" : "vpcLinkStatus", - "documentation" : "<p>The status of the VPC link.</p>" + "VpcLinkStatus": { + "shape": "VpcLinkStatus", + "locationName": "vpcLinkStatus", + "documentation": "<p>The status of the VPC link.</p>" }, - "VpcLinkStatusMessage" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "vpcLinkStatusMessage", - "documentation" : "<p>A message summarizing the cause of the status of the VPC link.</p>" + "VpcLinkStatusMessage": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "vpcLinkStatusMessage", + "documentation": "<p>A message summarizing the cause of the status of the VPC link.</p>" }, - "VpcLinkVersion" : { - "shape" : "VpcLinkVersion", - "locationName" : "vpcLinkVersion", - "documentation" : "<p>The version of the VPC link.</p>" + "VpcLinkVersion": { + "shape": "VpcLinkVersion", + "locationName": "vpcLinkVersion", + "documentation": "<p>The version of the VPC link.</p>" } } }, - "GetVpcLinksRequest" : { - "type" : "structure", - "members" : { - "MaxResults" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "maxResults", - "documentation" : "<p>The maximum number of elements to be returned for this resource.</p>" + "GetVpcLinksRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "__string", + "location": "querystring", + "locationName": "maxResults", + "documentation": "<p>The maximum number of elements to be returned for this resource.</p>" }, - "NextToken" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "GetVpcLinksResponse" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfVpcLink", - "locationName" : "items", - "documentation" : "<p>A collection of VPC links.</p>" + "GetVpcLinksResponse": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfVpcLink", + "locationName": "items", + "documentation": "<p>A collection of VPC links.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } } }, - "Id" : { - "type" : "string", - "documentation" : "<p>The identifier.</p>" + "Id": { + "type": "string", + "documentation": "<p>The identifier.</p>" }, - "IdentitySourceList" : { - "type" : "list", - "documentation" : "<p>The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</p>", - "member" : { - "shape" : "__string" + "IdentitySourceList": { + "type": "list", + "documentation": "<p>The identity source for which authorization is requested. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</p>", + "member": { + "shape": "__string" } }, - "ImportApiInput" : { - "type" : "structure", - "members" : { - "Body" : { - "shape" : "__string", - "locationName" : "body", - "documentation" : "<p>The OpenAPI definition. Supported only for HTTP APIs.</p>" + "ImportApiInput": { + "type": "structure", + "members": { + "Body": { + "shape": "__string", + "locationName": "body", + "documentation": "<p>The OpenAPI definition. Supported only for HTTP APIs.</p>" } }, - "documentation" : "<p>Represents the input to ImportAPI. Supported only for HTTP APIs.</p>", - "required" : [ "Body" ] + "documentation": "<p>Represents the input to ImportAPI. Supported only for HTTP APIs.</p>", + "required": [ + "Body" + ] }, - "ImportApiRequest" : { - "type" : "structure", - "members" : { - "Basepath" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "basepath", - "documentation" : "<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>" + "ImportApiRequest": { + "type": "structure", + "members": { + "Basepath": { + "shape": "__string", + "location": "querystring", + "locationName": "basepath", + "documentation": "<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>" }, - "Body" : { - "shape" : "__string", - "locationName" : "body", - "documentation" : "<p>The OpenAPI definition. Supported only for HTTP APIs.</p>" + "Body": { + "shape": "__string", + "locationName": "body", + "documentation": "<p>The OpenAPI definition. Supported only for HTTP APIs.</p>" }, - "FailOnWarnings" : { - "shape" : "__boolean", - "location" : "querystring", - "locationName" : "failOnWarnings", - "documentation" : "<p>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</p>" + "FailOnWarnings": { + "shape": "__boolean", + "location": "querystring", + "locationName": "failOnWarnings", + "documentation": "<p>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</p>" } }, - "documentation" : "<p></p>", - "required" : [ "Body" ] + "documentation": "<p></p>", + "required": [ + "Body" + ] }, - "ImportApiResponse" : { - "type" : "structure", - "members" : { - "ApiEndpoint" : { - "shape" : "__string", - "locationName" : "apiEndpoint", - "documentation" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" + "ImportApiResponse": { + "type": "structure", + "members": { + "ApiEndpoint": { + "shape": "__string", + "locationName": "apiEndpoint", + "documentation": "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" }, - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" }, - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API ID.</p>" + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API ID.</p>" }, - "ApiKeySelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiKeySelectionExpression", - "documentation" : "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" + "ApiKeySelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiKeySelectionExpression", + "documentation": "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" }, - "CorsConfiguration" : { - "shape" : "Cors", - "locationName" : "corsConfiguration", - "documentation" : "<p>A CORS configuration. Supported only for HTTP APIs.</p>" + "CorsConfiguration": { + "shape": "Cors", + "locationName": "corsConfiguration", + "documentation": "<p>A CORS configuration. Supported only for HTTP APIs.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the API was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the API was created.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the API.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the API.</p>" }, - "DisableSchemaValidation" : { - "shape" : "__boolean", - "locationName" : "disableSchemaValidation", - "documentation" : "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" + "DisableSchemaValidation": { + "shape": "__boolean", + "locationName": "disableSchemaValidation", + "documentation": "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" }, - "DisableExecuteApiEndpoint" : { - "shape" : "__boolean", - "locationName" : "disableExecuteApiEndpoint", - "documentation" : "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" + "DisableExecuteApiEndpoint": { + "shape": "__boolean", + "locationName": "disableExecuteApiEndpoint", + "documentation": "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" }, - "ImportInfo" : { - "shape" : "__listOf__string", - "locationName" : "importInfo", - "documentation" : "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" + "ImportInfo": { + "shape": "__listOf__string", + "locationName": "importInfo", + "documentation": "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the API.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the API.</p>" }, - "ProtocolType" : { - "shape" : "ProtocolType", - "locationName" : "protocolType", - "documentation" : "<p>The API protocol.</p>" + "ProtocolType": { + "shape": "ProtocolType", + "locationName": "protocolType", + "documentation": "<p>The API protocol.</p>" }, - "RouteSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeSelectionExpression", - "documentation" : "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" + "RouteSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeSelectionExpression", + "documentation": "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>A collection of tags associated with the API.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>A collection of tags associated with the API.</p>" }, - "Version" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "version", - "documentation" : "<p>A version identifier for the API.</p>" + "Version": { + "shape": "StringWithLengthBetween1And64", + "locationName": "version", + "documentation": "<p>A version identifier for the API.</p>" }, - "Warnings" : { - "shape" : "__listOf__string", - "locationName" : "warnings", - "documentation" : "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" + "Warnings": { + "shape": "__listOf__string", + "locationName": "warnings", + "documentation": "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" } } }, - "IntegerWithLengthBetween0And3600" : { - "type" : "integer", - "documentation" : "<p>An integer with a value between [0-3600].</p>", - "min" : 0, - "max" : 3600 + "IntegerWithLengthBetween0And3600": { + "type": "integer", + "documentation": "<p>An integer with a value between [0-3600].</p>", + "min": 0, + "max": 3600 }, - "IntegerWithLengthBetween50And30000" : { - "type" : "integer", - "documentation" : "<p>An integer with a value between [50-30000].</p>", - "min" : 50, - "max" : 30000 + "IntegerWithLengthBetween50And30000": { + "type": "integer", + "documentation": "<p>An integer with a value between [50-30000].</p>", + "min": 50, + "max": 30000 }, - "IntegerWithLengthBetweenMinus1And86400" : { - "type" : "integer", - "documentation" : "<p>An integer with a value between -1 and 86400. Supported only for HTTP APIs.</p>", - "min" : -1, - "max" : 86400 + "IntegerWithLengthBetweenMinus1And86400": { + "type": "integer", + "documentation": "<p>An integer with a value between -1 and 86400. Supported only for HTTP APIs.</p>", + "min": -1, + "max": 86400 }, - "Integration" : { - "type" : "structure", - "members" : { - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>" + "Integration": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>" }, - "ConnectionId" : { - "shape" : "StringWithLengthBetween1And1024", - "locationName" : "connectionId", - "documentation" : "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" + "ConnectionId": { + "shape": "StringWithLengthBetween1And1024", + "locationName": "connectionId", + "documentation": "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" }, - "ConnectionType" : { - "shape" : "ConnectionType", - "locationName" : "connectionType", - "documentation" : "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" + "ConnectionType": { + "shape": "ConnectionType", + "locationName": "connectionType", + "documentation": "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" }, - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>Represents the description of an integration.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>Represents the description of an integration.</p>" }, - "IntegrationId" : { - "shape" : "Id", - "locationName" : "integrationId", - "documentation" : "<p>Represents the identifier of an integration.</p>" + "IntegrationId": { + "shape": "Id", + "locationName": "integrationId", + "documentation": "<p>Represents the identifier of an integration.</p>" }, - "IntegrationMethod" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "integrationMethod", - "documentation" : "<p>Specifies the integration's HTTP method type.</p>" + "IntegrationMethod": { + "shape": "StringWithLengthBetween1And64", + "locationName": "integrationMethod", + "documentation": "<p>Specifies the integration's HTTP method type.</p>" }, - "IntegrationResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "integrationResponseSelectionExpression", - "documentation" : "<p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>" + "IntegrationResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "integrationResponseSelectionExpression", + "documentation": "<p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>" }, - "IntegrationSubtype" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "integrationSubtype", - "documentation" : "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" + "IntegrationSubtype": { + "shape": "StringWithLengthBetween1And128", + "locationName": "integrationSubtype", + "documentation": "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" }, - "IntegrationType" : { - "shape" : "IntegrationType", - "locationName" : "integrationType", - "documentation" : "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" + "IntegrationType": { + "shape": "IntegrationType", + "locationName": "integrationType", + "documentation": "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" }, - "IntegrationUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "integrationUri", - "documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" + "IntegrationUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "integrationUri", + "documentation": "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" }, - "PassthroughBehavior" : { - "shape" : "PassthroughBehavior", - "locationName" : "passthroughBehavior", - "documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" + "PassthroughBehavior": { + "shape": "PassthroughBehavior", + "locationName": "passthroughBehavior", + "documentation": "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" }, - "PayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "payloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>" + "PayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "payloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>" }, - "RequestParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "requestParameters", - "documentation" : "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "RequestParameters": { + "shape": "IntegrationParameters", + "locationName": "requestParameters", + "documentation": "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "RequestTemplates" : { - "shape" : "TemplateMap", - "locationName" : "requestTemplates", - "documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" + "RequestTemplates": { + "shape": "TemplateMap", + "locationName": "requestTemplates", + "documentation": "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" }, - "ResponseParameters" : { - "shape" : "ResponseParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "ResponseParameters": { + "shape": "ResponseParameters", + "locationName": "responseParameters", + "documentation": "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>" }, - "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And30000", - "locationName" : "timeoutInMillis", - "documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" + "TimeoutInMillis": { + "shape": "IntegerWithLengthBetween50And30000", + "locationName": "timeoutInMillis", + "documentation": "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" }, - "TlsConfig" : { - "shape" : "TlsConfig", - "locationName" : "tlsConfig", - "documentation" : "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" + "TlsConfig": { + "shape": "TlsConfig", + "locationName": "tlsConfig", + "documentation": "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" } }, - "documentation" : "<p>Represents an integration.</p>" + "documentation": "<p>Represents an integration.</p>" }, - "IntegrationParameters" : { - "type" : "map", - "documentation" : "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>", - "key" : { - "shape" : "__string" + "IntegrationParameters": { + "type": "map", + "documentation": "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>", + "key": { + "shape": "__string" }, - "value" : { - "shape" : "StringWithLengthBetween1And512" + "value": { + "shape": "StringWithLengthBetween1And512" } }, - "IntegrationResponse" : { - "type" : "structure", - "members" : { - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "IntegrationResponse": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "IntegrationResponseId" : { - "shape" : "Id", - "locationName" : "integrationResponseId", - "documentation" : "<p>The integration response ID.</p>" + "IntegrationResponseId": { + "shape": "Id", + "locationName": "integrationResponseId", + "documentation": "<p>The integration response ID.</p>" }, - "IntegrationResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "integrationResponseKey", - "documentation" : "<p>The integration response key.</p>" + "IntegrationResponseKey": { + "shape": "SelectionKey", + "locationName": "integrationResponseKey", + "documentation": "<p>The integration response key.</p>" }, - "ResponseParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "responseParameters", - "documentation" : "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>" + "ResponseParameters": { + "shape": "IntegrationParameters", + "locationName": "responseParameters", + "documentation": "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>" }, - "ResponseTemplates" : { - "shape" : "TemplateMap", - "locationName" : "responseTemplates", - "documentation" : "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" + "ResponseTemplates": { + "shape": "TemplateMap", + "locationName": "responseTemplates", + "documentation": "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expressions for the integration response.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expressions for the integration response.</p>" } }, - "documentation" : "<p>Represents an integration response.</p>", - "required" : [ "IntegrationResponseKey" ] + "documentation": "<p>Represents an integration response.</p>", + "required": [ + "IntegrationResponseKey" + ] }, - "IntegrationResponses" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfIntegrationResponse", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "IntegrationResponses": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfIntegrationResponse", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>Represents a collection of integration responses.</p>" + "documentation": "<p>Represents a collection of integration responses.</p>" }, - "IntegrationType" : { - "type" : "string", - "documentation" : "<p>Represents an API method integration type.</p>", - "enum" : [ "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY" ] + "IntegrationType": { + "type": "string", + "documentation": "<p>Represents an API method integration type.</p>", + "enum": [ + "AWS", + "HTTP", + "MOCK", + "HTTP_PROXY", + "AWS_PROXY" + ] }, - "Integrations" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfIntegration", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "Integrations": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfIntegration", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>Represents a collection of integrations.</p>" + "documentation": "<p>Represents a collection of integrations.</p>" }, - "JWTConfiguration" : { - "type" : "structure", - "members" : { - "Audience" : { - "shape" : "__listOf__string", - "locationName" : "audience", - "documentation" : "<p>A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href=\"https://tools.ietf.org/html/rfc7519#section-4.1.3\">RFC 7519</a>. Supported only for HTTP APIs.</p>" + "JWTConfiguration": { + "type": "structure", + "members": { + "Audience": { + "shape": "__listOf__string", + "locationName": "audience", + "documentation": "<p>A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See <a href=\"https://tools.ietf.org/html/rfc7519#section-4.1.3\">RFC 7519</a>. Supported only for HTTP APIs.</p>" }, - "Issuer" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "issuer", - "documentation" : "<p>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>{region}</replaceable>.amazonaws.com/<replaceable>{userPoolId}</replaceable>\n . Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" + "Issuer": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "issuer", + "documentation": "<p>The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.<replaceable>{region}</replaceable>.amazonaws.com/<replaceable>{userPoolId}</replaceable>\n . Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" } }, - "documentation" : "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" + "documentation": "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" }, - "LimitExceededException" : { - "type" : "structure", - "members" : { - "LimitType" : { - "shape" : "__string", - "locationName" : "limitType", - "documentation" : "<p>The limit type.</p>" + "LimitExceededException": { + "type": "structure", + "members": { + "LimitType": { + "shape": "__string", + "locationName": "limitType", + "documentation": "<p>The limit type.</p>" }, - "Message" : { - "shape" : "__string", - "locationName" : "message", - "documentation" : "<p>Describes the error encountered.</p>" + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "<p>Describes the error encountered.</p>" } }, - "documentation" : "<p>A limit has been exceeded. See the accompanying error message for details.</p>" + "documentation": "<p>A limit has been exceeded. See the accompanying error message for details.</p>" }, - "LoggingLevel" : { - "type" : "string", - "documentation" : "<p>The logging level.</p>", - "enum" : [ "ERROR", "INFO", "OFF" ] + "LoggingLevel": { + "type": "string", + "documentation": "<p>The logging level.</p>", + "enum": [ + "ERROR", + "INFO", + "OFF" + ] }, - "Model" : { - "type" : "structure", - "members" : { - "ContentType" : { - "shape" : "StringWithLengthBetween1And256", - "locationName" : "contentType", - "documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>" + "Model": { + "type": "structure", + "members": { + "ContentType": { + "shape": "StringWithLengthBetween1And256", + "locationName": "contentType", + "documentation": "<p>The content-type for the model, for example, \"application/json\".</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the model.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the model.</p>" }, - "ModelId" : { - "shape" : "Id", - "locationName" : "modelId", - "documentation" : "<p>The model identifier.</p>" + "ModelId": { + "shape": "Id", + "locationName": "modelId", + "documentation": "<p>The model identifier.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the model. Must be alphanumeric.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the model. Must be alphanumeric.</p>" }, - "Schema" : { - "shape" : "StringWithLengthBetween0And32K", - "locationName" : "schema", - "documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" + "Schema": { + "shape": "StringWithLengthBetween0And32K", + "locationName": "schema", + "documentation": "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" } }, - "documentation" : "<p>Represents a data model for an API. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Create Models and Mapping Templates for Request and Response Mappings</a>.</p>", - "required" : [ "Name" ] + "documentation": "<p>Represents a data model for an API. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Create Models and Mapping Templates for Request and Response Mappings</a>.</p>", + "required": [ + "Name" + ] }, - "Models" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfModel", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "Models": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfModel", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>Represents a collection of data models. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Create Models and Mapping Templates for Request and Response Mappings</a>.</p>" + "documentation": "<p>Represents a collection of data models. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Create Models and Mapping Templates for Request and Response Mappings</a>.</p>" }, - "MutualTlsAuthentication" : { - "type" : "structure", - "members" : { - "TruststoreUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "truststoreUri", - "documentation" : "<p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>" + "MutualTlsAuthentication": { + "type": "structure", + "members": { + "TruststoreUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "truststoreUri", + "documentation": "<p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>" }, - "TruststoreVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "truststoreVersion", - "documentation" : "<p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>" + "TruststoreVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "truststoreVersion", + "documentation": "<p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>" }, - "TruststoreWarnings" : { - "shape" : "__listOf__string", - "locationName" : "truststoreWarnings", - "documentation" : "<p>A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.</p>" + "TruststoreWarnings": { + "shape": "__listOf__string", + "locationName": "truststoreWarnings", + "documentation": "<p>A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.</p>" } } }, - "MutualTlsAuthenticationInput" : { - "type" : "structure", - "members" : { - "TruststoreUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "truststoreUri", - "documentation" : "<p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>" + "MutualTlsAuthenticationInput": { + "type": "structure", + "members": { + "TruststoreUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "truststoreUri", + "documentation": "<p>An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://<replaceable>bucket-name</replaceable>/<replaceable>key-name</replaceable>. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.</p>" }, - "TruststoreVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "truststoreVersion", - "documentation" : "<p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>" + "TruststoreVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "truststoreVersion", + "documentation": "<p>The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.</p>" } } }, - "NextToken" : { - "type" : "string", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "type": "string", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" }, - "NotFoundException" : { - "type" : "structure", - "members" : { - "Message" : { - "shape" : "__string", - "locationName" : "message", - "documentation" : "<p>Describes the error encountered.</p>" + "NotFoundException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "<p>Describes the error encountered.</p>" }, - "ResourceType" : { - "shape" : "__string", - "locationName" : "resourceType", - "documentation" : "<p>The resource type.</p>" + "ResourceType": { + "shape": "__string", + "locationName": "resourceType", + "documentation": "<p>The resource type.</p>" } }, - "documentation" : "<p>The resource specified in the request was not found. See the message field for more information.</p>", - "exception" : true, - "error" : { - "httpStatusCode" : 404 + "documentation": "<p>The resource specified in the request was not found. See the message field for more information.</p>", + "exception": true, + "error": { + "httpStatusCode": 404 } }, - "ParameterConstraints" : { - "type" : "structure", - "members" : { - "Required" : { - "shape" : "__boolean", - "locationName" : "required", - "documentation" : "<p>Whether or not the parameter is required.</p>" + "ParameterConstraints": { + "type": "structure", + "members": { + "Required": { + "shape": "__boolean", + "locationName": "required", + "documentation": "<p>Whether or not the parameter is required.</p>" } }, - "documentation" : "<p>Validation constraints imposed on parameters of a request (path, query string, headers).</p>" + "documentation": "<p>Validation constraints imposed on parameters of a request (path, query string, headers).</p>" }, - "PassthroughBehavior" : { - "type" : "string", - "documentation" : "<p>Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.</p>", - "enum" : [ "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES" ] + "PassthroughBehavior": { + "type": "string", + "documentation": "<p>Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.</p>", + "enum": [ + "WHEN_NO_MATCH", + "NEVER", + "WHEN_NO_TEMPLATES" + ] }, - "ProtocolType" : { - "type" : "string", - "documentation" : "Represents a protocol type.", - "enum" : [ "WEBSOCKET", "HTTP" ] + "ProtocolType": { + "type": "string", + "documentation": "Represents a protocol type.", + "enum": [ + "WEBSOCKET", + "HTTP" + ] }, - "ReimportApiInput" : { - "type" : "structure", - "members" : { - "Body" : { - "shape" : "__string", - "locationName" : "body", - "documentation" : "<p>The OpenAPI definition. Supported only for HTTP APIs.</p>" + "ReimportApiInput": { + "type": "structure", + "members": { + "Body": { + "shape": "__string", + "locationName": "body", + "documentation": "<p>The OpenAPI definition. Supported only for HTTP APIs.</p>" } }, - "documentation" : "<p>Overwrites the configuration of an existing API using the provided definition. Supported only for HTTP APIs.</p>", - "required" : [ "Body" ] + "documentation": "<p>Overwrites the configuration of an existing API using the provided definition. Supported only for HTTP APIs.</p>", + "required": [ + "Body" + ] }, - "ReimportApiRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "ReimportApiRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "Basepath" : { - "shape" : "__string", - "location" : "querystring", - "locationName" : "basepath", - "documentation" : "<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>" + "Basepath": { + "shape": "__string", + "location": "querystring", + "locationName": "basepath", + "documentation": "<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>" }, - "Body" : { - "shape" : "__string", - "locationName" : "body", - "documentation" : "<p>The OpenAPI definition. Supported only for HTTP APIs.</p>" + "Body": { + "shape": "__string", + "locationName": "body", + "documentation": "<p>The OpenAPI definition. Supported only for HTTP APIs.</p>" }, - "FailOnWarnings" : { - "shape" : "__boolean", - "location" : "querystring", - "locationName" : "failOnWarnings", - "documentation" : "<p>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</p>" + "FailOnWarnings": { + "shape": "__boolean", + "location": "querystring", + "locationName": "failOnWarnings", + "documentation": "<p>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</p>" } }, - "documentation" : "<p></p>", - "required" : [ "ApiId", "Body" ] + "documentation": "<p></p>", + "required": [ + "ApiId", + "Body" + ] }, - "ReimportApiResponse" : { - "type" : "structure", - "members" : { - "ApiEndpoint" : { - "shape" : "__string", - "locationName" : "apiEndpoint", - "documentation" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" + "ReimportApiResponse": { + "type": "structure", + "members": { + "ApiEndpoint": { + "shape": "__string", + "locationName": "apiEndpoint", + "documentation": "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" }, - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" }, - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API ID.</p>" + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API ID.</p>" }, - "ApiKeySelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiKeySelectionExpression", - "documentation" : "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" + "ApiKeySelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiKeySelectionExpression", + "documentation": "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" }, - "CorsConfiguration" : { - "shape" : "Cors", - "locationName" : "corsConfiguration", - "documentation" : "<p>A CORS configuration. Supported only for HTTP APIs.</p>" + "CorsConfiguration": { + "shape": "Cors", + "locationName": "corsConfiguration", + "documentation": "<p>A CORS configuration. Supported only for HTTP APIs.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the API was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the API was created.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the API.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the API.</p>" }, - "DisableSchemaValidation" : { - "shape" : "__boolean", - "locationName" : "disableSchemaValidation", - "documentation" : "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" + "DisableSchemaValidation": { + "shape": "__boolean", + "locationName": "disableSchemaValidation", + "documentation": "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" }, - "DisableExecuteApiEndpoint" : { - "shape" : "__boolean", - "locationName" : "disableExecuteApiEndpoint", - "documentation" : "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" + "DisableExecuteApiEndpoint": { + "shape": "__boolean", + "locationName": "disableExecuteApiEndpoint", + "documentation": "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" }, - "ImportInfo" : { - "shape" : "__listOf__string", - "locationName" : "importInfo", - "documentation" : "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" + "ImportInfo": { + "shape": "__listOf__string", + "locationName": "importInfo", + "documentation": "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the API.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the API.</p>" }, - "ProtocolType" : { - "shape" : "ProtocolType", - "locationName" : "protocolType", - "documentation" : "<p>The API protocol.</p>" + "ProtocolType": { + "shape": "ProtocolType", + "locationName": "protocolType", + "documentation": "<p>The API protocol.</p>" }, - "RouteSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeSelectionExpression", - "documentation" : "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" + "RouteSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeSelectionExpression", + "documentation": "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>A collection of tags associated with the API.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>A collection of tags associated with the API.</p>" }, - "Version" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "version", - "documentation" : "<p>A version identifier for the API.</p>" + "Version": { + "shape": "StringWithLengthBetween1And64", + "locationName": "version", + "documentation": "<p>A version identifier for the API.</p>" }, - "Warnings" : { - "shape" : "__listOf__string", - "locationName" : "warnings", - "documentation" : "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" + "Warnings": { + "shape": "__listOf__string", + "locationName": "warnings", + "documentation": "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" } } }, - "ResponseParameters" : { - "type" : "map", - "documentation" : "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.</p>", - "key" : { - "shape" : "__string" + "ResponseParameters": { + "type": "map", + "documentation": "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients.</p>", + "key": { + "shape": "__string" }, - "value" : { - "shape" : "IntegrationParameters" + "value": { + "shape": "IntegrationParameters" } }, - "Route" : { - "type" : "structure", - "members" : { - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>" + "Route": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>" }, - "ApiKeyRequired" : { - "shape" : "__boolean", - "locationName" : "apiKeyRequired", - "documentation" : "<p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>" + "ApiKeyRequired": { + "shape": "__boolean", + "locationName": "apiKeyRequired", + "documentation": "<p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>" }, - "AuthorizationScopes" : { - "shape" : "AuthorizationScopes", - "locationName" : "authorizationScopes", - "documentation" : "<p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>" + "AuthorizationScopes": { + "shape": "AuthorizationScopes", + "locationName": "authorizationScopes", + "documentation": "<p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>" }, - "AuthorizationType" : { - "shape" : "AuthorizationType", - "locationName" : "authorizationType", - "documentation" : "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" + "AuthorizationType": { + "shape": "AuthorizationType", + "locationName": "authorizationType", + "documentation": "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" }, - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "OperationName" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "operationName", - "documentation" : "<p>The operation name for the route.</p>" + "OperationName": { + "shape": "StringWithLengthBetween1And64", + "locationName": "operationName", + "documentation": "<p>The operation name for the route.</p>" }, - "RequestModels" : { - "shape" : "RouteModels", - "locationName" : "requestModels", - "documentation" : "<p>The request models for the route. Supported only for WebSocket APIs.</p>" + "RequestModels": { + "shape": "RouteModels", + "locationName": "requestModels", + "documentation": "<p>The request models for the route. Supported only for WebSocket APIs.</p>" }, - "RequestParameters" : { - "shape" : "RouteParameters", - "locationName" : "requestParameters", - "documentation" : "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" + "RequestParameters": { + "shape": "RouteParameters", + "locationName": "requestParameters", + "documentation": "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" }, - "RouteId" : { - "shape" : "Id", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "Id", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>The route key for the route.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>The route key for the route.</p>" }, - "RouteResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeResponseSelectionExpression", - "documentation" : "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" + "RouteResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeResponseSelectionExpression", + "documentation": "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "Target" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "target", - "documentation" : "<p>The target for the route.</p>" + "Target": { + "shape": "StringWithLengthBetween1And128", + "locationName": "target", + "documentation": "<p>The target for the route.</p>" } }, - "documentation" : "<p>Represents a route.</p>", - "required" : [ "RouteKey" ] + "documentation": "<p>Represents a route.</p>", + "required": [ + "RouteKey" + ] }, - "RouteModels" : { - "type" : "map", - "documentation" : "<p>The route models.</p>", - "key" : { - "shape" : "__string" + "RouteModels": { + "type": "map", + "documentation": "<p>The route models.</p>", + "key": { + "shape": "__string" }, - "value" : { - "shape" : "StringWithLengthBetween1And128" + "value": { + "shape": "StringWithLengthBetween1And128" } }, - "RouteParameters" : { - "type" : "map", - "documentation" : "<p>The route parameters.</p>", - "key" : { - "shape" : "__string" + "RouteParameters": { + "type": "map", + "documentation": "<p>The route parameters.</p>", + "key": { + "shape": "__string" }, - "value" : { - "shape" : "ParameterConstraints" + "value": { + "shape": "ParameterConstraints" } }, - "RouteResponse" : { - "type" : "structure", - "members" : { - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>" + "RouteResponse": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>" }, - "ResponseModels" : { - "shape" : "RouteModels", - "locationName" : "responseModels", - "documentation" : "<p>Represents the response models of a route response.</p>" + "ResponseModels": { + "shape": "RouteModels", + "locationName": "responseModels", + "documentation": "<p>Represents the response models of a route response.</p>" }, - "ResponseParameters" : { - "shape" : "RouteParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Represents the response parameters of a route response.</p>" + "ResponseParameters": { + "shape": "RouteParameters", + "locationName": "responseParameters", + "documentation": "<p>Represents the response parameters of a route response.</p>" }, - "RouteResponseId" : { - "shape" : "Id", - "locationName" : "routeResponseId", - "documentation" : "<p>Represents the identifier of a route response.</p>" + "RouteResponseId": { + "shape": "Id", + "locationName": "routeResponseId", + "documentation": "<p>Represents the identifier of a route response.</p>" }, - "RouteResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "routeResponseKey", - "documentation" : "<p>Represents the route response key of a route response.</p>" + "RouteResponseKey": { + "shape": "SelectionKey", + "locationName": "routeResponseKey", + "documentation": "<p>Represents the route response key of a route response.</p>" } }, - "documentation" : "<p>Represents a route response.</p>", - "required" : [ "RouteResponseKey" ] + "documentation": "<p>Represents a route response.</p>", + "required": [ + "RouteResponseKey" + ] }, - "RouteResponses" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfRouteResponse", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "RouteResponses": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfRouteResponse", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>Represents a collection of route responses.</p>" + "documentation": "<p>Represents a collection of route responses.</p>" }, - "RouteSettings" : { - "type" : "structure", - "members" : { - "DataTraceEnabled" : { - "shape" : "__boolean", - "locationName" : "dataTraceEnabled", - "documentation" : "<p>Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>" + "RouteSettings": { + "type": "structure", + "members": { + "DataTraceEnabled": { + "shape": "__boolean", + "locationName": "dataTraceEnabled", + "documentation": "<p>Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>" }, - "DetailedMetricsEnabled" : { - "shape" : "__boolean", - "locationName" : "detailedMetricsEnabled", - "documentation" : "<p>Specifies whether detailed metrics are enabled.</p>" + "DetailedMetricsEnabled": { + "shape": "__boolean", + "locationName": "detailedMetricsEnabled", + "documentation": "<p>Specifies whether detailed metrics are enabled.</p>" }, - "LoggingLevel" : { - "shape" : "LoggingLevel", - "locationName" : "loggingLevel", - "documentation" : "<p>Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>" + "LoggingLevel": { + "shape": "LoggingLevel", + "locationName": "loggingLevel", + "documentation": "<p>Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.</p>" }, - "ThrottlingBurstLimit" : { - "shape" : "__integer", - "locationName" : "throttlingBurstLimit", - "documentation" : "<p>Specifies the throttling burst limit.</p>" + "ThrottlingBurstLimit": { + "shape": "__integer", + "locationName": "throttlingBurstLimit", + "documentation": "<p>Specifies the throttling burst limit.</p>" }, - "ThrottlingRateLimit" : { - "shape" : "__double", - "locationName" : "throttlingRateLimit", - "documentation" : "<p>Specifies the throttling rate limit.</p>" + "ThrottlingRateLimit": { + "shape": "__double", + "locationName": "throttlingRateLimit", + "documentation": "<p>Specifies the throttling rate limit.</p>" } }, - "documentation" : "<p>Represents a collection of route settings.</p>" + "documentation": "<p>Represents a collection of route settings.</p>" }, - "RouteSettingsMap" : { - "type" : "map", - "documentation" : "<p>The route settings map.</p>", - "key" : { - "shape" : "__string" + "RouteSettingsMap": { + "type": "map", + "documentation": "<p>The route settings map.</p>", + "key": { + "shape": "__string" }, - "value" : { - "shape" : "RouteSettings" + "value": { + "shape": "RouteSettings" } }, - "Routes" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfRoute", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "Routes": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfRoute", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>Represents a collection of routes.</p>" + "documentation": "<p>Represents a collection of routes.</p>" }, - "SecurityGroupIdList" : { - "type" : "list", - "documentation" : "<p>A list of security group IDs for the VPC link.</p>", - "member" : { - "shape" : "__string" + "SecurityGroupIdList": { + "type": "list", + "documentation": "<p>A list of security group IDs for the VPC link.</p>", + "member": { + "shape": "__string" } }, - "SecurityPolicy" : { - "type" : "string", - "documentation" : "<p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>", - "enum" : [ "TLS_1_0", "TLS_1_2" ] + "SecurityPolicy": { + "type": "string", + "documentation": "<p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>", + "enum": [ + "TLS_1_0", + "TLS_1_2" + ] }, - "SelectionExpression" : { - "type" : "string", - "documentation" : "<p>An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.</p>" + "SelectionExpression": { + "type": "string", + "documentation": "<p>An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.</p>" }, - "SelectionKey" : { - "type" : "string", - "documentation" : "<p>After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.</p>" + "SelectionKey": { + "type": "string", + "documentation": "<p>After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.</p>" }, - "Stage" : { - "type" : "structure", - "members" : { - "AccessLogSettings" : { - "shape" : "AccessLogSettings", - "locationName" : "accessLogSettings", - "documentation" : "<p>Settings for logging access in this stage.</p>" + "Stage": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "AccessLogSettings", + "locationName": "accessLogSettings", + "documentation": "<p>Settings for logging access in this stage.</p>" }, - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>" + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>" }, - "AutoDeploy" : { - "shape" : "__boolean", - "locationName" : "autoDeploy", - "documentation" : "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" + "AutoDeploy": { + "shape": "__boolean", + "locationName": "autoDeploy", + "documentation": "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" }, - "ClientCertificateId" : { - "shape" : "Id", - "locationName" : "clientCertificateId", - "documentation" : "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" + "ClientCertificateId": { + "shape": "Id", + "locationName": "clientCertificateId", + "documentation": "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the stage was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the stage was created.</p>" }, - "DefaultRouteSettings" : { - "shape" : "RouteSettings", - "locationName" : "defaultRouteSettings", - "documentation" : "<p>Default route settings for the stage.</p>" + "DefaultRouteSettings": { + "shape": "RouteSettings", + "locationName": "defaultRouteSettings", + "documentation": "<p>Default route settings for the stage.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the stage.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the stage.</p>" }, - "LastDeploymentStatusMessage" : { - "shape" : "__string", - "locationName" : "lastDeploymentStatusMessage", - "documentation" : "<p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>" + "LastDeploymentStatusMessage": { + "shape": "__string", + "locationName": "lastDeploymentStatusMessage", + "documentation": "<p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>" }, - "LastUpdatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "lastUpdatedDate", - "documentation" : "<p>The timestamp when the stage was last updated.</p>" + "LastUpdatedDate": { + "shape": "__timestampIso8601", + "locationName": "lastUpdatedDate", + "documentation": "<p>The timestamp when the stage was last updated.</p>" }, - "RouteSettings" : { - "shape" : "RouteSettingsMap", - "locationName" : "routeSettings", - "documentation" : "<p>Route settings for the stage, by routeKey.</p>" + "RouteSettings": { + "shape": "RouteSettingsMap", + "locationName": "routeSettings", + "documentation": "<p>Route settings for the stage, by routeKey.</p>" }, - "StageName" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stageName", - "documentation" : "<p>The name of the stage.</p>" + "StageName": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stageName", + "documentation": "<p>The name of the stage.</p>" }, - "StageVariables" : { - "shape" : "StageVariablesMap", - "locationName" : "stageVariables", - "documentation" : "<p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" + "StageVariables": { + "shape": "StageVariablesMap", + "locationName": "stageVariables", + "documentation": "<p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags. Each tag element is associated with a given resource.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags. Each tag element is associated with a given resource.</p>" } }, - "documentation" : "<p>Represents an API stage.</p>", - "required" : [ "StageName" ] + "documentation": "<p>Represents an API stage.</p>", + "required": [ + "StageName" + ] }, - "StageVariablesMap" : { - "type" : "map", - "documentation" : "<p>The stage variable map.</p>", - "key" : { - "shape" : "__string" + "StageVariablesMap": { + "type": "map", + "documentation": "<p>The stage variable map.</p>", + "key": { + "shape": "__string" }, - "value" : { - "shape" : "StringWithLengthBetween0And2048" + "value": { + "shape": "StringWithLengthBetween0And2048" } }, - "Stages" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfStage", - "locationName" : "items", - "documentation" : "<p>The elements from this collection.</p>" + "Stages": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfStage", + "locationName": "items", + "documentation": "<p>The elements from this collection.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>A collection of Stage resources that are associated with the ApiKey resource.</p>" + "documentation": "<p>A collection of Stage resources that are associated with the ApiKey resource.</p>" }, - "StringWithLengthBetween0And1024" : { - "type" : "string", - "documentation" : "<p>A string with a length between [0-1024].</p>" + "StringWithLengthBetween0And1024": { + "type": "string", + "documentation": "<p>A string with a length between [0-1024].</p>" }, - "StringWithLengthBetween0And2048" : { - "type" : "string", - "documentation" : "<p>A string with a length between [0-2048].</p>" + "StringWithLengthBetween0And2048": { + "type": "string", + "documentation": "<p>A string with a length between [0-2048].</p>" }, - "StringWithLengthBetween0And32K" : { - "type" : "string", - "documentation" : "<p>A string with a length between [0-32768].</p>" + "StringWithLengthBetween0And32K": { + "type": "string", + "documentation": "<p>A string with a length between [0-32768].</p>" }, - "StringWithLengthBetween1And1024" : { - "type" : "string", - "documentation" : "<p>A string with a length between [1-1024].</p>" + "StringWithLengthBetween1And1024": { + "type": "string", + "documentation": "<p>A string with a length between [1-1024].</p>" }, - "StringWithLengthBetween1And128" : { - "type" : "string", - "documentation" : "<p>A string with a length between [1-128].</p>" + "StringWithLengthBetween1And128": { + "type": "string", + "documentation": "<p>A string with a length between [1-128].</p>" }, - "StringWithLengthBetween1And1600" : { - "type" : "string", - "documentation" : "<p>A string with a length between [0-1600].</p>" + "StringWithLengthBetween1And1600": { + "type": "string", + "documentation": "<p>A string with a length between [0-1600].</p>" }, - "StringWithLengthBetween1And256" : { - "type" : "string", - "documentation" : "<p>A string with a length between [1-256].</p>" + "StringWithLengthBetween1And256": { + "type": "string", + "documentation": "<p>A string with a length between [1-256].</p>" }, - "StringWithLengthBetween1And512" : { - "type" : "string", - "documentation" : "<p>A string with a length between [1-512].</p>" + "StringWithLengthBetween1And512": { + "type": "string", + "documentation": "<p>A string with a length between [1-512].</p>" }, - "StringWithLengthBetween1And64" : { - "type" : "string", - "documentation" : "<p>A string with a length between [1-64].</p>" + "StringWithLengthBetween1And64": { + "type": "string", + "documentation": "<p>A string with a length between [1-64].</p>" }, - "SubnetIdList" : { - "type" : "list", - "documentation" : "<p>A list of subnet IDs to include in the VPC link.</p>", - "member" : { - "shape" : "__string" + "SubnetIdList": { + "type": "list", + "documentation": "<p>A list of subnet IDs to include in the VPC link.</p>", + "member": { + "shape": "__string" } }, - "TagResourceInput" : { - "type" : "structure", - "members" : { - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags. Each tag element is associated with a given resource.</p>" + "TagResourceInput": { + "type": "structure", + "members": { + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags. Each tag element is associated with a given resource.</p>" } }, - "documentation" : "<p>Represents the input parameters for a TagResource request.</p>" + "documentation": "<p>Represents the input parameters for a TagResource request.</p>" }, - "TagResourceRequest" : { - "type" : "structure", - "members" : { - "ResourceArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "resource-arn", - "documentation" : "<p>The resource ARN for the tag.</p>" + "TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn", + "documentation": "<p>The resource ARN for the tag.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags. Each tag element is associated with a given resource.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags. Each tag element is associated with a given resource.</p>" } }, - "documentation" : "<p>Creates a new Tag resource to represent a tag.</p>", - "required" : [ "ResourceArn" ] + "documentation": "<p>Creates a new Tag resource to represent a tag.</p>", + "required": [ + "ResourceArn" + ] }, - "TagResourceResponse" : { - "type" : "structure", - "members" : { } + "TagResourceResponse": { + "type": "structure", + "members": { + } }, - "Tags" : { - "type" : "map", - "documentation" : "<p>Represents a collection of tags associated with the resource.</p>", - "key" : { - "shape" : "__string" + "Tags": { + "type": "map", + "documentation": "<p>Represents a collection of tags associated with the resource.</p>", + "key": { + "shape": "__string" }, - "value" : { - "shape" : "StringWithLengthBetween1And1600" + "value": { + "shape": "StringWithLengthBetween1And1600" } }, - "Template" : { - "type" : "structure", - "members" : { - "Value" : { - "shape" : "__string", - "locationName" : "value", - "documentation" : "<p>The template value.</p>" + "Template": { + "type": "structure", + "members": { + "Value": { + "shape": "__string", + "locationName": "value", + "documentation": "<p>The template value.</p>" } }, - "documentation" : "<p>Represents a template.</p>" + "documentation": "<p>Represents a template.</p>" }, - "TemplateMap" : { - "type" : "map", - "documentation" : "<p>A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.</p>", - "key" : { - "shape" : "__string" + "TemplateMap": { + "type": "map", + "documentation": "<p>A mapping of identifier keys to templates. The value is an actual template script. The key is typically a SelectionKey which is chosen based on evaluating a selection expression.</p>", + "key": { + "shape": "__string" }, - "value" : { - "shape" : "StringWithLengthBetween0And32K" + "value": { + "shape": "StringWithLengthBetween0And32K" } }, - "TlsConfig" : { - "type" : "structure", - "members" : { - "ServerNameToVerify" : { - "shape" : "StringWithLengthBetween1And512", - "locationName" : "serverNameToVerify", - "documentation" : "<p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>" + "TlsConfig": { + "type": "structure", + "members": { + "ServerNameToVerify": { + "shape": "StringWithLengthBetween1And512", + "locationName": "serverNameToVerify", + "documentation": "<p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>" } }, - "documentation" : "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" + "documentation": "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" }, - "TlsConfigInput" : { - "type" : "structure", - "members" : { - "ServerNameToVerify" : { - "shape" : "StringWithLengthBetween1And512", - "locationName" : "serverNameToVerify", - "documentation" : "<p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>" + "TlsConfigInput": { + "type": "structure", + "members": { + "ServerNameToVerify": { + "shape": "StringWithLengthBetween1And512", + "locationName": "serverNameToVerify", + "documentation": "<p>If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.</p>" } }, - "documentation" : "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" + "documentation": "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" }, - "TooManyRequestsException" : { - "type" : "structure", - "members" : { - "LimitType" : { - "shape" : "__string", - "locationName" : "limitType", - "documentation" : "<p>The limit type.</p>" + "TooManyRequestsException": { + "type": "structure", + "members": { + "LimitType": { + "shape": "__string", + "locationName": "limitType", + "documentation": "<p>The limit type.</p>" }, - "Message" : { - "shape" : "__string", - "locationName" : "message", - "documentation" : "<p>Describes the error encountered.</p>" + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "<p>Describes the error encountered.</p>" } }, - "documentation" : "<p>A limit has been exceeded. See the accompanying error message for details.</p>", - "exception" : true, - "error" : { - "httpStatusCode" : 429 + "documentation": "<p>A limit has been exceeded. See the accompanying error message for details.</p>", + "exception": true, + "error": { + "httpStatusCode": 429 } }, - "UntagResourceRequest" : { - "type" : "structure", - "members" : { - "ResourceArn" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "resource-arn", - "documentation" : "<p>The resource ARN for the tag.</p>" + "UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn", + "documentation": "<p>The resource ARN for the tag.</p>" }, - "TagKeys" : { - "shape" : "__listOf__string", - "location" : "querystring", - "locationName" : "tagKeys", - "documentation" : "<p>The Tag keys to delete</p>" + "TagKeys": { + "shape": "__listOf__string", + "location": "querystring", + "locationName": "tagKeys", + "documentation": "<p>The Tag keys to delete</p>" } }, - "required" : [ "ResourceArn", "TagKeys" ] + "required": [ + "ResourceArn", + "TagKeys" + ] }, - "UpdateApiInput" : { - "type" : "structure", - "members" : { - "ApiKeySelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiKeySelectionExpression", - "documentation" : "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" + "UpdateApiInput": { + "type": "structure", + "members": { + "ApiKeySelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiKeySelectionExpression", + "documentation": "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" }, - "CorsConfiguration" : { - "shape" : "Cors", - "locationName" : "corsConfiguration", - "documentation" : "<p>A CORS configuration. Supported only for HTTP APIs.</p>" + "CorsConfiguration": { + "shape": "Cors", + "locationName": "corsConfiguration", + "documentation": "<p>A CORS configuration. Supported only for HTTP APIs.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the API.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the API.</p>" }, - "DisableExecuteApiEndpoint" : { - "shape" : "__boolean", - "locationName" : "disableExecuteApiEndpoint", - "documentation" : "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" + "DisableExecuteApiEndpoint": { + "shape": "__boolean", + "locationName": "disableExecuteApiEndpoint", + "documentation": "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" }, - "DisableSchemaValidation" : { - "shape" : "__boolean", - "locationName" : "disableSchemaValidation", - "documentation" : "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" + "DisableSchemaValidation": { + "shape": "__boolean", + "locationName": "disableSchemaValidation", + "documentation": "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the API.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the API.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.</p>" }, - "RouteSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeSelectionExpression", - "documentation" : "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" + "RouteSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeSelectionExpression", + "documentation": "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" }, - "Target" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "target", - "documentation" : "<p>This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.</p>" + "Target": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "target", + "documentation": "<p>This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.</p>" }, - "Version" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "version", - "documentation" : "<p>A version identifier for the API.</p>" + "Version": { + "shape": "StringWithLengthBetween1And64", + "locationName": "version", + "documentation": "<p>A version identifier for the API.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateApi request.</p>" + "documentation": "<p>Represents the input parameters for an UpdateApi request.</p>" }, - "UpdateApiMappingInput" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateApiMappingInput": { + "type": "structure", + "members": { + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiMappingKey" : { - "shape" : "SelectionKey", - "locationName" : "apiMappingKey", - "documentation" : "<p>The API mapping key.</p>" + "ApiMappingKey": { + "shape": "SelectionKey", + "locationName": "apiMappingKey", + "documentation": "<p>The API mapping key.</p>" }, - "Stage" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stage", - "documentation" : "<p>The API stage.</p>" + "Stage": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stage", + "documentation": "<p>The API stage.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateApiMapping request.</p>" + "documentation": "<p>Represents the input parameters for an UpdateApiMapping request.</p>" }, - "UpdateApiMappingRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateApiMappingRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiMappingId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiMappingId", - "documentation" : "<p>The API mapping identifier.</p>" + "ApiMappingId": { + "shape": "__string", + "location": "uri", + "locationName": "apiMappingId", + "documentation": "<p>The API mapping identifier.</p>" }, - "ApiMappingKey" : { - "shape" : "SelectionKey", - "locationName" : "apiMappingKey", - "documentation" : "<p>The API mapping key.</p>" + "ApiMappingKey": { + "shape": "SelectionKey", + "locationName": "apiMappingKey", + "documentation": "<p>The API mapping key.</p>" }, - "DomainName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "domainName", - "documentation" : "<p>The domain name.</p>" + "DomainName": { + "shape": "__string", + "location": "uri", + "locationName": "domainName", + "documentation": "<p>The domain name.</p>" }, - "Stage" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stage", - "documentation" : "<p>The API stage.</p>" + "Stage": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stage", + "documentation": "<p>The API stage.</p>" } }, - "documentation" : "<p>Updates an ApiMapping.</p>", - "required" : [ "ApiMappingId", "ApiId", "DomainName" ] + "documentation": "<p>Updates an ApiMapping.</p>", + "required": [ + "ApiMappingId", + "ApiId", + "DomainName" + ] }, - "UpdateApiMappingResponse" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateApiMappingResponse": { + "type": "structure", + "members": { + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiMappingId" : { - "shape" : "Id", - "locationName" : "apiMappingId", - "documentation" : "<p>The API mapping identifier.</p>" + "ApiMappingId": { + "shape": "Id", + "locationName": "apiMappingId", + "documentation": "<p>The API mapping identifier.</p>" }, - "ApiMappingKey" : { - "shape" : "SelectionKey", - "locationName" : "apiMappingKey", - "documentation" : "<p>The API mapping key.</p>" + "ApiMappingKey": { + "shape": "SelectionKey", + "locationName": "apiMappingKey", + "documentation": "<p>The API mapping key.</p>" }, - "Stage" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stage", - "documentation" : "<p>The API stage.</p>" + "Stage": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stage", + "documentation": "<p>The API stage.</p>" } } }, - "UpdateApiRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateApiRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiKeySelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiKeySelectionExpression", - "documentation" : "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" + "ApiKeySelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiKeySelectionExpression", + "documentation": "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" }, - "CorsConfiguration" : { - "shape" : "Cors", - "locationName" : "corsConfiguration", - "documentation" : "<p>A CORS configuration. Supported only for HTTP APIs.</p>" + "CorsConfiguration": { + "shape": "Cors", + "locationName": "corsConfiguration", + "documentation": "<p>A CORS configuration. Supported only for HTTP APIs.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the API.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the API.</p>" }, - "DisableSchemaValidation" : { - "shape" : "__boolean", - "locationName" : "disableSchemaValidation", - "documentation" : "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" + "DisableSchemaValidation": { + "shape": "__boolean", + "locationName": "disableSchemaValidation", + "documentation": "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" }, - "DisableExecuteApiEndpoint" : { - "shape" : "__boolean", - "locationName" : "disableExecuteApiEndpoint", - "documentation" : "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" + "DisableExecuteApiEndpoint": { + "shape": "__boolean", + "locationName": "disableExecuteApiEndpoint", + "documentation": "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the API.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the API.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.</p>" }, - "RouteSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeSelectionExpression", - "documentation" : "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" + "RouteSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeSelectionExpression", + "documentation": "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" }, - "Target" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "target", - "documentation" : "<p>This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.</p>" + "Target": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "target", + "documentation": "<p>This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.</p>" }, - "Version" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "version", - "documentation" : "<p>A version identifier for the API.</p>" + "Version": { + "shape": "StringWithLengthBetween1And64", + "locationName": "version", + "documentation": "<p>A version identifier for the API.</p>" } }, - "documentation" : "<p>Updates an Api.</p>", - "required" : [ "ApiId" ] + "documentation": "<p>Updates an Api.</p>", + "required": [ + "ApiId" + ] }, - "UpdateApiResponse" : { - "type" : "structure", - "members" : { - "ApiEndpoint" : { - "shape" : "__string", - "locationName" : "apiEndpoint", - "documentation" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" + "UpdateApiResponse": { + "type": "structure", + "members": { + "ApiEndpoint": { + "shape": "__string", + "locationName": "apiEndpoint", + "documentation": "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.</p>" }, - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.</p>" }, - "ApiId" : { - "shape" : "Id", - "locationName" : "apiId", - "documentation" : "<p>The API ID.</p>" + "ApiId": { + "shape": "Id", + "locationName": "apiId", + "documentation": "<p>The API ID.</p>" }, - "ApiKeySelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiKeySelectionExpression", - "documentation" : "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" + "ApiKeySelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiKeySelectionExpression", + "documentation": "<p>An API key selection expression. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>" }, - "CorsConfiguration" : { - "shape" : "Cors", - "locationName" : "corsConfiguration", - "documentation" : "<p>A CORS configuration. Supported only for HTTP APIs.</p>" + "CorsConfiguration": { + "shape": "Cors", + "locationName": "corsConfiguration", + "documentation": "<p>A CORS configuration. Supported only for HTTP APIs.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the API was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the API was created.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the API.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the API.</p>" }, - "DisableSchemaValidation" : { - "shape" : "__boolean", - "locationName" : "disableSchemaValidation", - "documentation" : "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" + "DisableSchemaValidation": { + "shape": "__boolean", + "locationName": "disableSchemaValidation", + "documentation": "<p>Avoid validating models when creating a deployment. Supported only for WebSocket APIs.</p>" }, - "DisableExecuteApiEndpoint" : { - "shape" : "__boolean", - "locationName" : "disableExecuteApiEndpoint", - "documentation" : "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" + "DisableExecuteApiEndpoint": { + "shape": "__boolean", + "locationName": "disableExecuteApiEndpoint", + "documentation": "<p>Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.</p>" }, - "ImportInfo" : { - "shape" : "__listOf__string", - "locationName" : "importInfo", - "documentation" : "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" + "ImportInfo": { + "shape": "__listOf__string", + "locationName": "importInfo", + "documentation": "<p>The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the API.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the API.</p>" }, - "ProtocolType" : { - "shape" : "ProtocolType", - "locationName" : "protocolType", - "documentation" : "<p>The API protocol.</p>" + "ProtocolType": { + "shape": "ProtocolType", + "locationName": "protocolType", + "documentation": "<p>The API protocol.</p>" }, - "RouteSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeSelectionExpression", - "documentation" : "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" + "RouteSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeSelectionExpression", + "documentation": "<p>The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>A collection of tags associated with the API.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>A collection of tags associated with the API.</p>" }, - "Version" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "version", - "documentation" : "<p>A version identifier for the API.</p>" + "Version": { + "shape": "StringWithLengthBetween1And64", + "locationName": "version", + "documentation": "<p>A version identifier for the API.</p>" }, - "Warnings" : { - "shape" : "__listOf__string", - "locationName" : "warnings", - "documentation" : "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" + "Warnings": { + "shape": "__listOf__string", + "locationName": "warnings", + "documentation": "<p>The warning messages reported when failonwarnings is turned on during API import.</p>" } } }, - "UpdateAuthorizerInput" : { - "type" : "structure", - "members" : { - "AuthorizerCredentialsArn" : { - "shape" : "Arn", - "locationName" : "authorizerCredentialsArn", - "documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter.</p>" + "UpdateAuthorizerInput": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "shape": "Arn", + "locationName": "authorizerCredentialsArn", + "documentation": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter.</p>" }, - "AuthorizerPayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "authorizerPayloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" + "AuthorizerPayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "authorizerPayloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" }, - "AuthorizerResultTtlInSeconds" : { - "shape" : "IntegerWithLengthBetween0And3600", - "locationName" : "authorizerResultTtlInSeconds", - "documentation" : "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" + "AuthorizerResultTtlInSeconds": { + "shape": "IntegerWithLengthBetween0And3600", + "locationName": "authorizerResultTtlInSeconds", + "documentation": "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" }, - "AuthorizerType" : { - "shape" : "AuthorizerType", - "locationName" : "authorizerType", - "documentation" : "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" + "AuthorizerType": { + "shape": "AuthorizerType", + "locationName": "authorizerType", + "documentation": "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" }, - "AuthorizerUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "authorizerUri", - "documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" + "AuthorizerUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "authorizerUri", + "documentation": "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" }, - "EnableSimpleResponses" : { - "shape" : "__boolean", - "locationName" : "enableSimpleResponses", - "documentation" : "<p>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" + "EnableSimpleResponses": { + "shape": "__boolean", + "locationName": "enableSimpleResponses", + "documentation": "<p>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" }, - "IdentitySource" : { - "shape" : "IdentitySourceList", - "locationName" : "identitySource", - "documentation" : "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" + "IdentitySource": { + "shape": "IdentitySourceList", + "locationName": "identitySource", + "documentation": "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" }, - "IdentityValidationExpression" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "identityValidationExpression", - "documentation" : "<p>This parameter is not used.</p>" + "IdentityValidationExpression": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "identityValidationExpression", + "documentation": "<p>This parameter is not used.</p>" }, - "JwtConfiguration" : { - "shape" : "JWTConfiguration", - "locationName" : "jwtConfiguration", - "documentation" : "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" + "JwtConfiguration": { + "shape": "JWTConfiguration", + "locationName": "jwtConfiguration", + "documentation": "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the authorizer.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the authorizer.</p>" } }, - "documentation" : "<p>The input parameters for an UpdateAuthorizer request.</p>" + "documentation": "<p>The input parameters for an UpdateAuthorizer request.</p>" }, - "UpdateAuthorizerRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateAuthorizerRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "AuthorizerCredentialsArn" : { - "shape" : "Arn", - "locationName" : "authorizerCredentialsArn", - "documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter.</p>" + "AuthorizerCredentialsArn": { + "shape": "Arn", + "locationName": "authorizerCredentialsArn", + "documentation": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter.</p>" }, - "AuthorizerId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "authorizerId", - "documentation" : "<p>The authorizer identifier.</p>" + "AuthorizerId": { + "shape": "__string", + "location": "uri", + "locationName": "authorizerId", + "documentation": "<p>The authorizer identifier.</p>" }, - "AuthorizerPayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "authorizerPayloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" + "AuthorizerPayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "authorizerPayloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" }, - "AuthorizerResultTtlInSeconds" : { - "shape" : "IntegerWithLengthBetween0And3600", - "locationName" : "authorizerResultTtlInSeconds", - "documentation" : "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" + "AuthorizerResultTtlInSeconds": { + "shape": "IntegerWithLengthBetween0And3600", + "locationName": "authorizerResultTtlInSeconds", + "documentation": "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" }, - "AuthorizerType" : { - "shape" : "AuthorizerType", - "locationName" : "authorizerType", - "documentation" : "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" + "AuthorizerType": { + "shape": "AuthorizerType", + "locationName": "authorizerType", + "documentation": "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" }, - "AuthorizerUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "authorizerUri", - "documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" + "AuthorizerUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "authorizerUri", + "documentation": "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" }, - "EnableSimpleResponses" : { - "shape" : "__boolean", - "locationName" : "enableSimpleResponses", - "documentation" : "<p>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" + "EnableSimpleResponses": { + "shape": "__boolean", + "locationName": "enableSimpleResponses", + "documentation": "<p>Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" }, - "IdentitySource" : { - "shape" : "IdentitySourceList", - "locationName" : "identitySource", - "documentation" : "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" + "IdentitySource": { + "shape": "IdentitySourceList", + "locationName": "identitySource", + "documentation": "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" }, - "IdentityValidationExpression" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "identityValidationExpression", - "documentation" : "<p>This parameter is not used.</p>" + "IdentityValidationExpression": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "identityValidationExpression", + "documentation": "<p>This parameter is not used.</p>" }, - "JwtConfiguration" : { - "shape" : "JWTConfiguration", - "locationName" : "jwtConfiguration", - "documentation" : "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" + "JwtConfiguration": { + "shape": "JWTConfiguration", + "locationName": "jwtConfiguration", + "documentation": "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the authorizer.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the authorizer.</p>" } }, - "documentation" : "<p>Updates an Authorizer.</p>", - "required" : [ "AuthorizerId", "ApiId" ] + "documentation": "<p>Updates an Authorizer.</p>", + "required": [ + "AuthorizerId", + "ApiId" + ] }, - "UpdateAuthorizerResponse" : { - "type" : "structure", - "members" : { - "AuthorizerCredentialsArn" : { - "shape" : "Arn", - "locationName" : "authorizerCredentialsArn", - "documentation" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" + "UpdateAuthorizerResponse": { + "type": "structure", + "members": { + "AuthorizerCredentialsArn": { + "shape": "Arn", + "locationName": "authorizerCredentialsArn", + "documentation": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The authorizer identifier.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The authorizer identifier.</p>" }, - "AuthorizerPayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "authorizerPayloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" + "AuthorizerPayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "authorizerPayloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p>" }, - "AuthorizerResultTtlInSeconds" : { - "shape" : "IntegerWithLengthBetween0And3600", - "locationName" : "authorizerResultTtlInSeconds", - "documentation" : "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" + "AuthorizerResultTtlInSeconds": { + "shape": "IntegerWithLengthBetween0And3600", + "locationName": "authorizerResultTtlInSeconds", + "documentation": "<p>The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.</p>" }, - "AuthorizerType" : { - "shape" : "AuthorizerType", - "locationName" : "authorizerType", - "documentation" : "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" + "AuthorizerType": { + "shape": "AuthorizerType", + "locationName": "authorizerType", + "documentation": "<p>The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).</p>" }, - "AuthorizerUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "authorizerUri", - "documentation" : "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" + "AuthorizerUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "authorizerUri", + "documentation": "<p>The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>\n , where <replaceable></replaceable>{region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.</p>" }, - "EnableSimpleResponses" : { - "shape" : "__boolean", - "locationName" : "enableSimpleResponses", - "documentation" : "<p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" + "EnableSimpleResponses": { + "shape": "__boolean", + "locationName": "enableSimpleResponses", + "documentation": "<p>Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a></p>" }, - "IdentitySource" : { - "shape" : "IdentitySourceList", - "locationName" : "identitySource", - "documentation" : "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" + "IdentitySource": { + "shape": "IdentitySourceList", + "locationName": "identitySource", + "documentation": "<p>The identity source for which authorization is requested.</p> <p>For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html\">Working with AWS Lambda authorizers for HTTP APIs</a>.</p> <p>For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.</p>" }, - "IdentityValidationExpression" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "identityValidationExpression", - "documentation" : "<p>The validation expression does not apply to the REQUEST authorizer.</p>" + "IdentityValidationExpression": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "identityValidationExpression", + "documentation": "<p>The validation expression does not apply to the REQUEST authorizer.</p>" }, - "JwtConfiguration" : { - "shape" : "JWTConfiguration", - "locationName" : "jwtConfiguration", - "documentation" : "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" + "JwtConfiguration": { + "shape": "JWTConfiguration", + "locationName": "jwtConfiguration", + "documentation": "<p>Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the authorizer.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the authorizer.</p>" } } }, - "UpdateDeploymentInput" : { - "type" : "structure", - "members" : { - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the deployment resource.</p>" + "UpdateDeploymentInput": { + "type": "structure", + "members": { + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the deployment resource.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateDeployment request.</p>" + "documentation": "<p>Represents the input parameters for an UpdateDeployment request.</p>" }, - "UpdateDeploymentRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateDeploymentRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "DeploymentId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "deploymentId", - "documentation" : "<p>The deployment ID.</p>" + "DeploymentId": { + "shape": "__string", + "location": "uri", + "locationName": "deploymentId", + "documentation": "<p>The deployment ID.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the deployment resource.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the deployment resource.</p>" } }, - "documentation" : "<p>Updates a Deployment.</p>", - "required" : [ "ApiId", "DeploymentId" ] + "documentation": "<p>Updates a Deployment.</p>", + "required": [ + "ApiId", + "DeploymentId" + ] }, - "UpdateDeploymentResponse" : { - "type" : "structure", - "members" : { - "AutoDeployed" : { - "shape" : "__boolean", - "locationName" : "autoDeployed", - "documentation" : "<p>Specifies whether a deployment was automatically released.</p>" + "UpdateDeploymentResponse": { + "type": "structure", + "members": { + "AutoDeployed": { + "shape": "__boolean", + "locationName": "autoDeployed", + "documentation": "<p>Specifies whether a deployment was automatically released.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The date and time when the Deployment resource was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The date and time when the Deployment resource was created.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The identifier for the deployment.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The identifier for the deployment.</p>" }, - "DeploymentStatus" : { - "shape" : "DeploymentStatus", - "locationName" : "deploymentStatus", - "documentation" : "<p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>" + "DeploymentStatus": { + "shape": "DeploymentStatus", + "locationName": "deploymentStatus", + "documentation": "<p>The status of the deployment: PENDING, FAILED, or SUCCEEDED.</p>" }, - "DeploymentStatusMessage" : { - "shape" : "__string", - "locationName" : "deploymentStatusMessage", - "documentation" : "<p>May contain additional feedback on the status of an API deployment.</p>" + "DeploymentStatusMessage": { + "shape": "__string", + "locationName": "deploymentStatusMessage", + "documentation": "<p>May contain additional feedback on the status of an API deployment.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the deployment.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the deployment.</p>" } } }, - "UpdateDomainNameInput" : { - "type" : "structure", - "members" : { - "DomainNameConfigurations" : { - "shape" : "DomainNameConfigurations", - "locationName" : "domainNameConfigurations", - "documentation" : "<p>The domain name configurations.</p>" + "UpdateDomainNameInput": { + "type": "structure", + "members": { + "DomainNameConfigurations": { + "shape": "DomainNameConfigurations", + "locationName": "domainNameConfigurations", + "documentation": "<p>The domain name configurations.</p>" }, - "MutualTlsAuthentication" : { - "shape" : "MutualTlsAuthenticationInput", - "locationName" : "mutualTlsAuthentication", - "documentation" : "<p>The mutual TLS authentication configuration for a custom domain name.</p>" + "MutualTlsAuthentication": { + "shape": "MutualTlsAuthenticationInput", + "locationName": "mutualTlsAuthentication", + "documentation": "<p>The mutual TLS authentication configuration for a custom domain name.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateDomainName request.</p>" + "documentation": "<p>Represents the input parameters for an UpdateDomainName request.</p>" }, - "UpdateDomainNameRequest" : { - "type" : "structure", - "members" : { - "DomainName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "domainName", - "documentation" : "<p>The domain name.</p>" + "UpdateDomainNameRequest": { + "type": "structure", + "members": { + "DomainName": { + "shape": "__string", + "location": "uri", + "locationName": "domainName", + "documentation": "<p>The domain name.</p>" }, - "DomainNameConfigurations" : { - "shape" : "DomainNameConfigurations", - "locationName" : "domainNameConfigurations", - "documentation" : "<p>The domain name configurations.</p>" + "DomainNameConfigurations": { + "shape": "DomainNameConfigurations", + "locationName": "domainNameConfigurations", + "documentation": "<p>The domain name configurations.</p>" }, - "MutualTlsAuthentication" : { - "shape" : "MutualTlsAuthenticationInput", - "locationName" : "mutualTlsAuthentication", - "documentation" : "<p>The mutual TLS authentication configuration for a custom domain name.</p>" + "MutualTlsAuthentication": { + "shape": "MutualTlsAuthenticationInput", + "locationName": "mutualTlsAuthentication", + "documentation": "<p>The mutual TLS authentication configuration for a custom domain name.</p>" } }, - "documentation" : "<p>Updates a DomainName.</p>", - "required" : [ "DomainName" ] + "documentation": "<p>Updates a DomainName.</p>", + "required": [ + "DomainName" + ] }, - "UpdateDomainNameResponse" : { - "type" : "structure", - "members" : { - "ApiMappingSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "apiMappingSelectionExpression", - "documentation" : "<p>The API mapping selection expression.</p>" + "UpdateDomainNameResponse": { + "type": "structure", + "members": { + "ApiMappingSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "apiMappingSelectionExpression", + "documentation": "<p>The API mapping selection expression.</p>" }, - "DomainName" : { - "shape" : "StringWithLengthBetween1And512", - "locationName" : "domainName", - "documentation" : "<p>The name of the DomainName resource.</p>" + "DomainName": { + "shape": "StringWithLengthBetween1And512", + "locationName": "domainName", + "documentation": "<p>The name of the DomainName resource.</p>" }, - "DomainNameConfigurations" : { - "shape" : "DomainNameConfigurations", - "locationName" : "domainNameConfigurations", - "documentation" : "<p>The domain name configurations.</p>" + "DomainNameConfigurations": { + "shape": "DomainNameConfigurations", + "locationName": "domainNameConfigurations", + "documentation": "<p>The domain name configurations.</p>" }, - "MutualTlsAuthentication" : { - "shape" : "MutualTlsAuthentication", - "locationName" : "mutualTlsAuthentication", - "documentation" : "<p>The mutual TLS authentication configuration for a custom domain name.</p>" + "MutualTlsAuthentication": { + "shape": "MutualTlsAuthentication", + "locationName": "mutualTlsAuthentication", + "documentation": "<p>The mutual TLS authentication configuration for a custom domain name.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags associated with a domain name.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags associated with a domain name.</p>" } } }, - "UpdateIntegrationInput" : { - "type" : "structure", - "members" : { - "ConnectionId" : { - "shape" : "StringWithLengthBetween1And1024", - "locationName" : "connectionId", - "documentation" : "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" + "UpdateIntegrationInput": { + "type": "structure", + "members": { + "ConnectionId": { + "shape": "StringWithLengthBetween1And1024", + "locationName": "connectionId", + "documentation": "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" }, - "ConnectionType" : { - "shape" : "ConnectionType", - "locationName" : "connectionType", - "documentation" : "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" + "ConnectionType": { + "shape": "ConnectionType", + "locationName": "connectionType", + "documentation": "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" }, - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the integration</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the integration</p>" }, - "IntegrationMethod" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "integrationMethod", - "documentation" : "<p>Specifies the integration's HTTP method type.</p>" + "IntegrationMethod": { + "shape": "StringWithLengthBetween1And64", + "locationName": "integrationMethod", + "documentation": "<p>Specifies the integration's HTTP method type.</p>" }, - "IntegrationSubtype" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "integrationSubtype", - "documentation" : "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" + "IntegrationSubtype": { + "shape": "StringWithLengthBetween1And128", + "locationName": "integrationSubtype", + "documentation": "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" }, - "IntegrationType" : { - "shape" : "IntegrationType", - "locationName" : "integrationType", - "documentation" : "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" + "IntegrationType": { + "shape": "IntegrationType", + "locationName": "integrationType", + "documentation": "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" }, - "IntegrationUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "integrationUri", - "documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" + "IntegrationUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "integrationUri", + "documentation": "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" }, - "PassthroughBehavior" : { - "shape" : "PassthroughBehavior", - "locationName" : "passthroughBehavior", - "documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" + "PassthroughBehavior": { + "shape": "PassthroughBehavior", + "locationName": "passthroughBehavior", + "documentation": "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" }, - "PayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "payloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>" + "PayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "payloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>" }, - "RequestParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "requestParameters", - "documentation" : "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "RequestParameters": { + "shape": "IntegrationParameters", + "locationName": "requestParameters", + "documentation": "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "RequestTemplates" : { - "shape" : "TemplateMap", - "locationName" : "requestTemplates", - "documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" + "RequestTemplates": { + "shape": "TemplateMap", + "locationName": "requestTemplates", + "documentation": "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" }, - "ResponseParameters" : { - "shape" : "ResponseParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "ResponseParameters": { + "shape": "ResponseParameters", + "locationName": "responseParameters", + "documentation": "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration.</p>" }, - "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And30000", - "locationName" : "timeoutInMillis", - "documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" + "TimeoutInMillis": { + "shape": "IntegerWithLengthBetween50And30000", + "locationName": "timeoutInMillis", + "documentation": "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" }, - "TlsConfig" : { - "shape" : "TlsConfigInput", - "locationName" : "tlsConfig", - "documentation" : "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" + "TlsConfig": { + "shape": "TlsConfigInput", + "locationName": "tlsConfig", + "documentation": "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateIntegration request.</p>" + "documentation": "<p>Represents the input parameters for an UpdateIntegration request.</p>" }, - "UpdateIntegrationRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateIntegrationRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ConnectionId" : { - "shape" : "StringWithLengthBetween1And1024", - "locationName" : "connectionId", - "documentation" : "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" + "ConnectionId": { + "shape": "StringWithLengthBetween1And1024", + "locationName": "connectionId", + "documentation": "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" }, - "ConnectionType" : { - "shape" : "ConnectionType", - "locationName" : "connectionType", - "documentation" : "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" + "ConnectionType": { + "shape": "ConnectionType", + "locationName": "connectionType", + "documentation": "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" }, - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the integration</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the integration</p>" }, - "IntegrationId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationId", - "documentation" : "<p>The integration ID.</p>" + "IntegrationId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationId", + "documentation": "<p>The integration ID.</p>" }, - "IntegrationMethod" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "integrationMethod", - "documentation" : "<p>Specifies the integration's HTTP method type.</p>" + "IntegrationMethod": { + "shape": "StringWithLengthBetween1And64", + "locationName": "integrationMethod", + "documentation": "<p>Specifies the integration's HTTP method type.</p>" }, - "IntegrationSubtype" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "integrationSubtype", - "documentation" : "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" + "IntegrationSubtype": { + "shape": "StringWithLengthBetween1And128", + "locationName": "integrationSubtype", + "documentation": "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" }, - "IntegrationType" : { - "shape" : "IntegrationType", - "locationName" : "integrationType", - "documentation" : "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" + "IntegrationType": { + "shape": "IntegrationType", + "locationName": "integrationType", + "documentation": "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" }, - "IntegrationUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "integrationUri", - "documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" + "IntegrationUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "integrationUri", + "documentation": "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" }, - "PassthroughBehavior" : { - "shape" : "PassthroughBehavior", - "locationName" : "passthroughBehavior", - "documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" + "PassthroughBehavior": { + "shape": "PassthroughBehavior", + "locationName": "passthroughBehavior", + "documentation": "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" }, - "PayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "payloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>" + "PayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "payloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>" }, - "RequestParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "requestParameters", - "documentation" : "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "RequestParameters": { + "shape": "IntegrationParameters", + "locationName": "requestParameters", + "documentation": "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "RequestTemplates" : { - "shape" : "TemplateMap", - "locationName" : "requestTemplates", - "documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" + "RequestTemplates": { + "shape": "TemplateMap", + "locationName": "requestTemplates", + "documentation": "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" }, - "ResponseParameters" : { - "shape" : "ResponseParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "ResponseParameters": { + "shape": "ResponseParameters", + "locationName": "responseParameters", + "documentation": "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration.</p>" }, - "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And30000", - "locationName" : "timeoutInMillis", - "documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" + "TimeoutInMillis": { + "shape": "IntegerWithLengthBetween50And30000", + "locationName": "timeoutInMillis", + "documentation": "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" }, - "TlsConfig" : { - "shape" : "TlsConfigInput", - "locationName" : "tlsConfig", - "documentation" : "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" + "TlsConfig": { + "shape": "TlsConfigInput", + "locationName": "tlsConfig", + "documentation": "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" } }, - "documentation" : "<p>Updates an Integration.</p>", - "required" : [ "ApiId", "IntegrationId" ] + "documentation": "<p>Updates an Integration.</p>", + "required": [ + "ApiId", + "IntegrationId" + ] }, - "UpdateIntegrationResult" : { - "type" : "structure", - "members" : { - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>" + "UpdateIntegrationResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.</p>" }, - "ConnectionId" : { - "shape" : "StringWithLengthBetween1And1024", - "locationName" : "connectionId", - "documentation" : "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" + "ConnectionId": { + "shape": "StringWithLengthBetween1And1024", + "locationName": "connectionId", + "documentation": "<p>The ID of the VPC link for a private integration. Supported only for HTTP APIs.</p>" }, - "ConnectionType" : { - "shape" : "ConnectionType", - "locationName" : "connectionType", - "documentation" : "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" + "ConnectionType": { + "shape": "ConnectionType", + "locationName": "connectionType", + "documentation": "<p>The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.</p>" }, - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "CredentialsArn" : { - "shape" : "Arn", - "locationName" : "credentialsArn", - "documentation" : "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" + "CredentialsArn": { + "shape": "Arn", + "locationName": "credentialsArn", + "documentation": "<p>Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>Represents the description of an integration.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>Represents the description of an integration.</p>" }, - "IntegrationId" : { - "shape" : "Id", - "locationName" : "integrationId", - "documentation" : "<p>Represents the identifier of an integration.</p>" + "IntegrationId": { + "shape": "Id", + "locationName": "integrationId", + "documentation": "<p>Represents the identifier of an integration.</p>" }, - "IntegrationMethod" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "integrationMethod", - "documentation" : "<p>Specifies the integration's HTTP method type.</p>" + "IntegrationMethod": { + "shape": "StringWithLengthBetween1And64", + "locationName": "integrationMethod", + "documentation": "<p>Specifies the integration's HTTP method type.</p>" }, - "IntegrationResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "integrationResponseSelectionExpression", - "documentation" : "<p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>" + "IntegrationResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "integrationResponseSelectionExpression", + "documentation": "<p>The integration response selection expression for the integration. Supported only for WebSocket APIs. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>" }, - "IntegrationSubtype" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "integrationSubtype", - "documentation" : "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" + "IntegrationSubtype": { + "shape": "StringWithLengthBetween1And128", + "locationName": "integrationSubtype", + "documentation": "<p>Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.html\">Integration subtype reference</a>.</p>" }, - "IntegrationType" : { - "shape" : "IntegrationType", - "locationName" : "integrationType", - "documentation" : "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" + "IntegrationType": { + "shape": "IntegrationType", + "locationName": "integrationType", + "documentation": "<p>The integration type of an integration. One of the following:</p> <p>AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.</p> <p>AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.</p> <p>HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.</p> <p>HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.</p> <p>MOCK: for integrating the route or method request with API Gateway as a \"loopback\" endpoint without invoking any backend. Supported only for WebSocket APIs.</p>" }, - "IntegrationUri" : { - "shape" : "UriWithLengthBetween1And2048", - "locationName" : "integrationUri", - "documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" + "IntegrationUri": { + "shape": "UriWithLengthBetween1And2048", + "locationName": "integrationUri", + "documentation": "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>" }, - "PassthroughBehavior" : { - "shape" : "PassthroughBehavior", - "locationName" : "passthroughBehavior", - "documentation" : "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" + "PassthroughBehavior": { + "shape": "PassthroughBehavior", + "locationName": "passthroughBehavior", + "documentation": "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.</p> <p>WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.</p> <p>NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.</p> <p>WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.</p>" }, - "PayloadFormatVersion" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "payloadFormatVersion", - "documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>" + "PayloadFormatVersion": { + "shape": "StringWithLengthBetween1And64", + "locationName": "payloadFormatVersion", + "documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>" }, - "RequestParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "requestParameters", - "documentation" : "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "RequestParameters": { + "shape": "IntegrationParameters", + "locationName": "requestParameters", + "documentation": "<p>For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.<replaceable>{location}</replaceable>.<replaceable>{name}</replaceable>\n , where \n <replaceable>{location}</replaceable>\n is querystring, path, or header; and \n <replaceable>{name}</replaceable>\n must be a valid and unique method request parameter name.</p> <p>For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html\">Working with AWS service integrations for HTTP APIs</a>.</p> <p>For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "RequestTemplates" : { - "shape" : "TemplateMap", - "locationName" : "requestTemplates", - "documentation" : "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" + "RequestTemplates": { + "shape": "TemplateMap", + "locationName": "requestTemplates", + "documentation": "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.</p>" }, - "ResponseParameters" : { - "shape" : "ResponseParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" + "ResponseParameters": { + "shape": "ResponseParameters", + "locationName": "responseParameters", + "documentation": "<p>Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html\">Transforming API requests and responses</a>.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration. Supported only for WebSocket APIs.</p>" }, - "TimeoutInMillis" : { - "shape" : "IntegerWithLengthBetween50And30000", - "locationName" : "timeoutInMillis", - "documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" + "TimeoutInMillis": { + "shape": "IntegerWithLengthBetween50And30000", + "locationName": "timeoutInMillis", + "documentation": "<p>Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.</p>" }, - "TlsConfig" : { - "shape" : "TlsConfig", - "locationName" : "tlsConfig", - "documentation" : "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" + "TlsConfig": { + "shape": "TlsConfig", + "locationName": "tlsConfig", + "documentation": "<p>The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.</p>" } } }, - "UpdateIntegrationResponseInput" : { - "type" : "structure", - "members" : { - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "UpdateIntegrationResponseInput": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "IntegrationResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "integrationResponseKey", - "documentation" : "<p>The integration response key.</p>" + "IntegrationResponseKey": { + "shape": "SelectionKey", + "locationName": "integrationResponseKey", + "documentation": "<p>The integration response key.</p>" }, - "ResponseParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "responseParameters", - "documentation" : "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.<replaceable>{name}</replaceable>\n , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.<replaceable>{name}</replaceable>\n or integration.response.body.<replaceable>{JSON-expression}</replaceable>\n , where \n <replaceable>{name}</replaceable>\n is a valid and unique response header name and \n <replaceable>{JSON-expression}</replaceable>\n is a valid JSON expression without the $ prefix.</p>" + "ResponseParameters": { + "shape": "IntegrationParameters", + "locationName": "responseParameters", + "documentation": "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.<replaceable>{name}</replaceable>\n , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.<replaceable>{name}</replaceable>\n or integration.response.body.<replaceable>{JSON-expression}</replaceable>\n , where \n <replaceable>{name}</replaceable>\n is a valid and unique response header name and \n <replaceable>{JSON-expression}</replaceable>\n is a valid JSON expression without the $ prefix.</p>" }, - "ResponseTemplates" : { - "shape" : "TemplateMap", - "locationName" : "responseTemplates", - "documentation" : "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" + "ResponseTemplates": { + "shape": "TemplateMap", + "locationName": "responseTemplates", + "documentation": "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration response. Supported only for WebSocket APIs.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration response. Supported only for WebSocket APIs.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateIntegrationResponse request.</p>" + "documentation": "<p>Represents the input parameters for an UpdateIntegrationResponse request.</p>" }, - "UpdateIntegrationResponseRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateIntegrationResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "IntegrationId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationId", - "documentation" : "<p>The integration ID.</p>" + "IntegrationId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationId", + "documentation": "<p>The integration ID.</p>" }, - "IntegrationResponseId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "integrationResponseId", - "documentation" : "<p>The integration response ID.</p>" + "IntegrationResponseId": { + "shape": "__string", + "location": "uri", + "locationName": "integrationResponseId", + "documentation": "<p>The integration response ID.</p>" }, - "IntegrationResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "integrationResponseKey", - "documentation" : "<p>The integration response key.</p>" + "IntegrationResponseKey": { + "shape": "SelectionKey", + "locationName": "integrationResponseKey", + "documentation": "<p>The integration response key.</p>" }, - "ResponseParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "responseParameters", - "documentation" : "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.<replaceable>{name}</replaceable>\n , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.<replaceable>{name}</replaceable>\n or integration.response.body.<replaceable>{JSON-expression}</replaceable>\n , where \n <replaceable>{name}</replaceable>\n is a valid and unique response header name and \n <replaceable>{JSON-expression}</replaceable>\n is a valid JSON expression without the $ prefix.</p>" + "ResponseParameters": { + "shape": "IntegrationParameters", + "locationName": "responseParameters", + "documentation": "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.<replaceable>{name}</replaceable>\n , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.<replaceable>{name}</replaceable>\n or integration.response.body.<replaceable>{JSON-expression}</replaceable>\n , where \n <replaceable>{name}</replaceable>\n is a valid and unique response header name and \n <replaceable>{JSON-expression}</replaceable>\n is a valid JSON expression without the $ prefix.</p>" }, - "ResponseTemplates" : { - "shape" : "TemplateMap", - "locationName" : "responseTemplates", - "documentation" : "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" + "ResponseTemplates": { + "shape": "TemplateMap", + "locationName": "responseTemplates", + "documentation": "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expression for the integration response. Supported only for WebSocket APIs.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expression for the integration response. Supported only for WebSocket APIs.</p>" } }, - "documentation" : "<p>Updates an IntegrationResponses.</p>", - "required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ] + "documentation": "<p>Updates an IntegrationResponses.</p>", + "required": [ + "ApiId", + "IntegrationResponseId", + "IntegrationId" + ] }, - "UpdateIntegrationResponseResponse" : { - "type" : "structure", - "members" : { - "ContentHandlingStrategy" : { - "shape" : "ContentHandlingStrategy", - "locationName" : "contentHandlingStrategy", - "documentation" : "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" + "UpdateIntegrationResponseResponse": { + "type": "structure", + "members": { + "ContentHandlingStrategy": { + "shape": "ContentHandlingStrategy", + "locationName": "contentHandlingStrategy", + "documentation": "<p>Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:</p> <p>CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.</p> <p>CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.</p>" }, - "IntegrationResponseId" : { - "shape" : "Id", - "locationName" : "integrationResponseId", - "documentation" : "<p>The integration response ID.</p>" + "IntegrationResponseId": { + "shape": "Id", + "locationName": "integrationResponseId", + "documentation": "<p>The integration response ID.</p>" }, - "IntegrationResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "integrationResponseKey", - "documentation" : "<p>The integration response key.</p>" + "IntegrationResponseKey": { + "shape": "SelectionKey", + "locationName": "integrationResponseKey", + "documentation": "<p>The integration response key.</p>" }, - "ResponseParameters" : { - "shape" : "IntegrationParameters", - "locationName" : "responseParameters", - "documentation" : "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>" + "ResponseParameters": { + "shape": "IntegrationParameters", + "locationName": "responseParameters", + "documentation": "<p>A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.</p>" }, - "ResponseTemplates" : { - "shape" : "TemplateMap", - "locationName" : "responseTemplates", - "documentation" : "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" + "ResponseTemplates": { + "shape": "TemplateMap", + "locationName": "responseTemplates", + "documentation": "<p>The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.</p>" }, - "TemplateSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "templateSelectionExpression", - "documentation" : "<p>The template selection expressions for the integration response.</p>" + "TemplateSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "templateSelectionExpression", + "documentation": "<p>The template selection expressions for the integration response.</p>" } } }, - "UpdateModelInput" : { - "type" : "structure", - "members" : { - "ContentType" : { - "shape" : "StringWithLengthBetween1And256", - "locationName" : "contentType", - "documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>" + "UpdateModelInput": { + "type": "structure", + "members": { + "ContentType": { + "shape": "StringWithLengthBetween1And256", + "locationName": "contentType", + "documentation": "<p>The content-type for the model, for example, \"application/json\".</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the model.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the model.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the model.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the model.</p>" }, - "Schema" : { - "shape" : "StringWithLengthBetween0And32K", - "locationName" : "schema", - "documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" + "Schema": { + "shape": "StringWithLengthBetween0And32K", + "locationName": "schema", + "documentation": "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateModel request. Supported only for WebSocket APIs.</p>" + "documentation": "<p>Represents the input parameters for an UpdateModel request. Supported only for WebSocket APIs.</p>" }, - "UpdateModelRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateModelRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ContentType" : { - "shape" : "StringWithLengthBetween1And256", - "locationName" : "contentType", - "documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>" + "ContentType": { + "shape": "StringWithLengthBetween1And256", + "locationName": "contentType", + "documentation": "<p>The content-type for the model, for example, \"application/json\".</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the model.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the model.</p>" }, - "ModelId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "modelId", - "documentation" : "<p>The model ID.</p>" + "ModelId": { + "shape": "__string", + "location": "uri", + "locationName": "modelId", + "documentation": "<p>The model ID.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the model.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the model.</p>" }, - "Schema" : { - "shape" : "StringWithLengthBetween0And32K", - "locationName" : "schema", - "documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" + "Schema": { + "shape": "StringWithLengthBetween0And32K", + "locationName": "schema", + "documentation": "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" } }, - "documentation" : "<p>Updates a Model.</p>", - "required" : [ "ModelId", "ApiId" ] + "documentation": "<p>Updates a Model.</p>", + "required": [ + "ModelId", + "ApiId" + ] }, - "UpdateModelResponse" : { - "type" : "structure", - "members" : { - "ContentType" : { - "shape" : "StringWithLengthBetween1And256", - "locationName" : "contentType", - "documentation" : "<p>The content-type for the model, for example, \"application/json\".</p>" + "UpdateModelResponse": { + "type": "structure", + "members": { + "ContentType": { + "shape": "StringWithLengthBetween1And256", + "locationName": "contentType", + "documentation": "<p>The content-type for the model, for example, \"application/json\".</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the model.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the model.</p>" }, - "ModelId" : { - "shape" : "Id", - "locationName" : "modelId", - "documentation" : "<p>The model identifier.</p>" + "ModelId": { + "shape": "Id", + "locationName": "modelId", + "documentation": "<p>The model identifier.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the model. Must be alphanumeric.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the model. Must be alphanumeric.</p>" }, - "Schema" : { - "shape" : "StringWithLengthBetween0And32K", - "locationName" : "schema", - "documentation" : "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" + "Schema": { + "shape": "StringWithLengthBetween0And32K", + "locationName": "schema", + "documentation": "<p>The schema for the model. For application/json models, this should be JSON schema draft 4 model.</p>" } } }, - "UpdateRouteInput" : { - "type" : "structure", - "members" : { - "ApiKeyRequired" : { - "shape" : "__boolean", - "locationName" : "apiKeyRequired", - "documentation" : "<p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>" + "UpdateRouteInput": { + "type": "structure", + "members": { + "ApiKeyRequired": { + "shape": "__boolean", + "locationName": "apiKeyRequired", + "documentation": "<p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>" }, - "AuthorizationScopes" : { - "shape" : "AuthorizationScopes", - "locationName" : "authorizationScopes", - "documentation" : "<p>The authorization scopes supported by this route.</p>" + "AuthorizationScopes": { + "shape": "AuthorizationScopes", + "locationName": "authorizationScopes", + "documentation": "<p>The authorization scopes supported by this route.</p>" }, - "AuthorizationType" : { - "shape" : "AuthorizationType", - "locationName" : "authorizationType", - "documentation" : "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" + "AuthorizationType": { + "shape": "AuthorizationType", + "locationName": "authorizationType", + "documentation": "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" }, - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "OperationName" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "operationName", - "documentation" : "<p>The operation name for the route.</p>" + "OperationName": { + "shape": "StringWithLengthBetween1And64", + "locationName": "operationName", + "documentation": "<p>The operation name for the route.</p>" }, - "RequestModels" : { - "shape" : "RouteModels", - "locationName" : "requestModels", - "documentation" : "<p>The request models for the route. Supported only for WebSocket APIs.</p>" + "RequestModels": { + "shape": "RouteModels", + "locationName": "requestModels", + "documentation": "<p>The request models for the route. Supported only for WebSocket APIs.</p>" }, - "RequestParameters" : { - "shape" : "RouteParameters", - "locationName" : "requestParameters", - "documentation" : "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" + "RequestParameters": { + "shape": "RouteParameters", + "locationName": "requestParameters", + "documentation": "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>The route key for the route.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>The route key for the route.</p>" }, - "RouteResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeResponseSelectionExpression", - "documentation" : "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" + "RouteResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeResponseSelectionExpression", + "documentation": "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "Target" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "target", - "documentation" : "<p>The target for the route.</p>" + "Target": { + "shape": "StringWithLengthBetween1And128", + "locationName": "target", + "documentation": "<p>The target for the route.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateRoute request.</p>" + "documentation": "<p>Represents the input parameters for an UpdateRoute request.</p>" }, - "UpdateRouteRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateRouteRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ApiKeyRequired" : { - "shape" : "__boolean", - "locationName" : "apiKeyRequired", - "documentation" : "<p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>" + "ApiKeyRequired": { + "shape": "__boolean", + "locationName": "apiKeyRequired", + "documentation": "<p>Specifies whether an API key is required for the route. Supported only for WebSocket APIs.</p>" }, - "AuthorizationScopes" : { - "shape" : "AuthorizationScopes", - "locationName" : "authorizationScopes", - "documentation" : "<p>The authorization scopes supported by this route.</p>" + "AuthorizationScopes": { + "shape": "AuthorizationScopes", + "locationName": "authorizationScopes", + "documentation": "<p>The authorization scopes supported by this route.</p>" }, - "AuthorizationType" : { - "shape" : "AuthorizationType", - "locationName" : "authorizationType", - "documentation" : "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" + "AuthorizationType": { + "shape": "AuthorizationType", + "locationName": "authorizationType", + "documentation": "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" }, - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "OperationName" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "operationName", - "documentation" : "<p>The operation name for the route.</p>" + "OperationName": { + "shape": "StringWithLengthBetween1And64", + "locationName": "operationName", + "documentation": "<p>The operation name for the route.</p>" }, - "RequestModels" : { - "shape" : "RouteModels", - "locationName" : "requestModels", - "documentation" : "<p>The request models for the route. Supported only for WebSocket APIs.</p>" + "RequestModels": { + "shape": "RouteModels", + "locationName": "requestModels", + "documentation": "<p>The request models for the route. Supported only for WebSocket APIs.</p>" }, - "RequestParameters" : { - "shape" : "RouteParameters", - "locationName" : "requestParameters", - "documentation" : "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" + "RequestParameters": { + "shape": "RouteParameters", + "locationName": "requestParameters", + "documentation": "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" }, - "RouteId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "__string", + "location": "uri", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>The route key for the route.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>The route key for the route.</p>" }, - "RouteResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeResponseSelectionExpression", - "documentation" : "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" + "RouteResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeResponseSelectionExpression", + "documentation": "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "Target" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "target", - "documentation" : "<p>The target for the route.</p>" + "Target": { + "shape": "StringWithLengthBetween1And128", + "locationName": "target", + "documentation": "<p>The target for the route.</p>" } }, - "documentation" : "<p>Updates a Route.</p>", - "required" : [ "ApiId", "RouteId" ] + "documentation": "<p>Updates a Route.</p>", + "required": [ + "ApiId", + "RouteId" + ] }, - "UpdateRouteResult" : { - "type" : "structure", - "members" : { - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>" + "UpdateRouteResult": { + "type": "structure", + "members": { + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.</p>" }, - "ApiKeyRequired" : { - "shape" : "__boolean", - "locationName" : "apiKeyRequired", - "documentation" : "<p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>" + "ApiKeyRequired": { + "shape": "__boolean", + "locationName": "apiKeyRequired", + "documentation": "<p>Specifies whether an API key is required for this route. Supported only for WebSocket APIs.</p>" }, - "AuthorizationScopes" : { - "shape" : "AuthorizationScopes", - "locationName" : "authorizationScopes", - "documentation" : "<p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>" + "AuthorizationScopes": { + "shape": "AuthorizationScopes", + "locationName": "authorizationScopes", + "documentation": "<p>A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>" }, - "AuthorizationType" : { - "shape" : "AuthorizationType", - "locationName" : "authorizationType", - "documentation" : "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" + "AuthorizationType": { + "shape": "AuthorizationType", + "locationName": "authorizationType", + "documentation": "<p>The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.</p>" }, - "AuthorizerId" : { - "shape" : "Id", - "locationName" : "authorizerId", - "documentation" : "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" + "AuthorizerId": { + "shape": "Id", + "locationName": "authorizerId", + "documentation": "<p>The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>" }, - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "OperationName" : { - "shape" : "StringWithLengthBetween1And64", - "locationName" : "operationName", - "documentation" : "<p>The operation name for the route.</p>" + "OperationName": { + "shape": "StringWithLengthBetween1And64", + "locationName": "operationName", + "documentation": "<p>The operation name for the route.</p>" }, - "RequestModels" : { - "shape" : "RouteModels", - "locationName" : "requestModels", - "documentation" : "<p>The request models for the route. Supported only for WebSocket APIs.</p>" + "RequestModels": { + "shape": "RouteModels", + "locationName": "requestModels", + "documentation": "<p>The request models for the route. Supported only for WebSocket APIs.</p>" }, - "RequestParameters" : { - "shape" : "RouteParameters", - "locationName" : "requestParameters", - "documentation" : "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" + "RequestParameters": { + "shape": "RouteParameters", + "locationName": "requestParameters", + "documentation": "<p>The request parameters for the route. Supported only for WebSocket APIs.</p>" }, - "RouteId" : { - "shape" : "Id", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "Id", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" }, - "RouteKey" : { - "shape" : "SelectionKey", - "locationName" : "routeKey", - "documentation" : "<p>The route key for the route.</p>" + "RouteKey": { + "shape": "SelectionKey", + "locationName": "routeKey", + "documentation": "<p>The route key for the route.</p>" }, - "RouteResponseSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "routeResponseSelectionExpression", - "documentation" : "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" + "RouteResponseSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "routeResponseSelectionExpression", + "documentation": "<p>The route response selection expression for the route. Supported only for WebSocket APIs.</p>" }, - "Target" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "target", - "documentation" : "<p>The target for the route.</p>" + "Target": { + "shape": "StringWithLengthBetween1And128", + "locationName": "target", + "documentation": "<p>The target for the route.</p>" } } }, - "UpdateRouteResponseInput" : { - "type" : "structure", - "members" : { - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>" + "UpdateRouteResponseInput": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>" }, - "ResponseModels" : { - "shape" : "RouteModels", - "locationName" : "responseModels", - "documentation" : "<p>The response models for the route response.</p>" + "ResponseModels": { + "shape": "RouteModels", + "locationName": "responseModels", + "documentation": "<p>The response models for the route response.</p>" }, - "ResponseParameters" : { - "shape" : "RouteParameters", - "locationName" : "responseParameters", - "documentation" : "<p>The route response parameters.</p>" + "ResponseParameters": { + "shape": "RouteParameters", + "locationName": "responseParameters", + "documentation": "<p>The route response parameters.</p>" }, - "RouteResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "routeResponseKey", - "documentation" : "<p>The route response key.</p>" + "RouteResponseKey": { + "shape": "SelectionKey", + "locationName": "routeResponseKey", + "documentation": "<p>The route response key.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateRouteResponse request.</p>" + "documentation": "<p>Represents the input parameters for an UpdateRouteResponse request.</p>" }, - "UpdateRouteResponseRequest" : { - "type" : "structure", - "members" : { - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "UpdateRouteResponseRequest": { + "type": "structure", + "members": { + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>" + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>" }, - "ResponseModels" : { - "shape" : "RouteModels", - "locationName" : "responseModels", - "documentation" : "<p>The response models for the route response.</p>" + "ResponseModels": { + "shape": "RouteModels", + "locationName": "responseModels", + "documentation": "<p>The response models for the route response.</p>" }, - "ResponseParameters" : { - "shape" : "RouteParameters", - "locationName" : "responseParameters", - "documentation" : "<p>The route response parameters.</p>" + "ResponseParameters": { + "shape": "RouteParameters", + "locationName": "responseParameters", + "documentation": "<p>The route response parameters.</p>" }, - "RouteId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeId", - "documentation" : "<p>The route ID.</p>" + "RouteId": { + "shape": "__string", + "location": "uri", + "locationName": "routeId", + "documentation": "<p>The route ID.</p>" }, - "RouteResponseId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "routeResponseId", - "documentation" : "<p>The route response ID.</p>" + "RouteResponseId": { + "shape": "__string", + "location": "uri", + "locationName": "routeResponseId", + "documentation": "<p>The route response ID.</p>" }, - "RouteResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "routeResponseKey", - "documentation" : "<p>The route response key.</p>" + "RouteResponseKey": { + "shape": "SelectionKey", + "locationName": "routeResponseKey", + "documentation": "<p>The route response key.</p>" } }, - "documentation" : "<p>Updates a RouteResponse.</p>", - "required" : [ "RouteResponseId", "ApiId", "RouteId" ] + "documentation": "<p>Updates a RouteResponse.</p>", + "required": [ + "RouteResponseId", + "ApiId", + "RouteId" + ] }, - "UpdateRouteResponseResponse" : { - "type" : "structure", - "members" : { - "ModelSelectionExpression" : { - "shape" : "SelectionExpression", - "locationName" : "modelSelectionExpression", - "documentation" : "<p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>" + "UpdateRouteResponseResponse": { + "type": "structure", + "members": { + "ModelSelectionExpression": { + "shape": "SelectionExpression", + "locationName": "modelSelectionExpression", + "documentation": "<p>Represents the model selection expression of a route response. Supported only for WebSocket APIs.</p>" }, - "ResponseModels" : { - "shape" : "RouteModels", - "locationName" : "responseModels", - "documentation" : "<p>Represents the response models of a route response.</p>" + "ResponseModels": { + "shape": "RouteModels", + "locationName": "responseModels", + "documentation": "<p>Represents the response models of a route response.</p>" }, - "ResponseParameters" : { - "shape" : "RouteParameters", - "locationName" : "responseParameters", - "documentation" : "<p>Represents the response parameters of a route response.</p>" + "ResponseParameters": { + "shape": "RouteParameters", + "locationName": "responseParameters", + "documentation": "<p>Represents the response parameters of a route response.</p>" }, - "RouteResponseId" : { - "shape" : "Id", - "locationName" : "routeResponseId", - "documentation" : "<p>Represents the identifier of a route response.</p>" + "RouteResponseId": { + "shape": "Id", + "locationName": "routeResponseId", + "documentation": "<p>Represents the identifier of a route response.</p>" }, - "RouteResponseKey" : { - "shape" : "SelectionKey", - "locationName" : "routeResponseKey", - "documentation" : "<p>Represents the route response key of a route response.</p>" + "RouteResponseKey": { + "shape": "SelectionKey", + "locationName": "routeResponseKey", + "documentation": "<p>Represents the route response key of a route response.</p>" } } }, - "UpdateStageInput" : { - "type" : "structure", - "members" : { - "AccessLogSettings" : { - "shape" : "AccessLogSettings", - "locationName" : "accessLogSettings", - "documentation" : "<p>Settings for logging access in this stage.</p>" + "UpdateStageInput": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "AccessLogSettings", + "locationName": "accessLogSettings", + "documentation": "<p>Settings for logging access in this stage.</p>" }, - "AutoDeploy" : { - "shape" : "__boolean", - "locationName" : "autoDeploy", - "documentation" : "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" + "AutoDeploy": { + "shape": "__boolean", + "locationName": "autoDeploy", + "documentation": "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" }, - "ClientCertificateId" : { - "shape" : "Id", - "locationName" : "clientCertificateId", - "documentation" : "<p>The identifier of a client certificate for a Stage.</p>" + "ClientCertificateId": { + "shape": "Id", + "locationName": "clientCertificateId", + "documentation": "<p>The identifier of a client certificate for a Stage.</p>" }, - "DefaultRouteSettings" : { - "shape" : "RouteSettings", - "locationName" : "defaultRouteSettings", - "documentation" : "<p>The default route settings for the stage.</p>" + "DefaultRouteSettings": { + "shape": "RouteSettings", + "locationName": "defaultRouteSettings", + "documentation": "<p>The default route settings for the stage.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the API stage.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the API stage.</p>" }, - "RouteSettings" : { - "shape" : "RouteSettingsMap", - "locationName" : "routeSettings", - "documentation" : "<p>Route settings for the stage.</p>" + "RouteSettings": { + "shape": "RouteSettingsMap", + "locationName": "routeSettings", + "documentation": "<p>Route settings for the stage.</p>" }, - "StageVariables" : { - "shape" : "StageVariablesMap", - "locationName" : "stageVariables", - "documentation" : "<p>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" + "StageVariables": { + "shape": "StageVariablesMap", + "locationName": "stageVariables", + "documentation": "<p>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateStage request.</p>" + "documentation": "<p>Represents the input parameters for an UpdateStage request.</p>" }, - "UpdateStageRequest" : { - "type" : "structure", - "members" : { - "AccessLogSettings" : { - "shape" : "AccessLogSettings", - "locationName" : "accessLogSettings", - "documentation" : "<p>Settings for logging access in this stage.</p>" + "UpdateStageRequest": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "AccessLogSettings", + "locationName": "accessLogSettings", + "documentation": "<p>Settings for logging access in this stage.</p>" }, - "ApiId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "apiId", - "documentation" : "<p>The API identifier.</p>" + "ApiId": { + "shape": "__string", + "location": "uri", + "locationName": "apiId", + "documentation": "<p>The API identifier.</p>" }, - "AutoDeploy" : { - "shape" : "__boolean", - "locationName" : "autoDeploy", - "documentation" : "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" + "AutoDeploy": { + "shape": "__boolean", + "locationName": "autoDeploy", + "documentation": "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" }, - "ClientCertificateId" : { - "shape" : "Id", - "locationName" : "clientCertificateId", - "documentation" : "<p>The identifier of a client certificate for a Stage.</p>" + "ClientCertificateId": { + "shape": "Id", + "locationName": "clientCertificateId", + "documentation": "<p>The identifier of a client certificate for a Stage.</p>" }, - "DefaultRouteSettings" : { - "shape" : "RouteSettings", - "locationName" : "defaultRouteSettings", - "documentation" : "<p>The default route settings for the stage.</p>" + "DefaultRouteSettings": { + "shape": "RouteSettings", + "locationName": "defaultRouteSettings", + "documentation": "<p>The default route settings for the stage.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description for the API stage.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description for the API stage.</p>" }, - "RouteSettings" : { - "shape" : "RouteSettingsMap", - "locationName" : "routeSettings", - "documentation" : "<p>Route settings for the stage.</p>" + "RouteSettings": { + "shape": "RouteSettingsMap", + "locationName": "routeSettings", + "documentation": "<p>Route settings for the stage.</p>" }, - "StageName" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "stageName", - "documentation" : "<p>The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.</p>" + "StageName": { + "shape": "__string", + "location": "uri", + "locationName": "stageName", + "documentation": "<p>The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.</p>" }, - "StageVariables" : { - "shape" : "StageVariablesMap", - "locationName" : "stageVariables", - "documentation" : "<p>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" + "StageVariables": { + "shape": "StageVariablesMap", + "locationName": "stageVariables", + "documentation": "<p>A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" } }, - "documentation" : "<p>Updates a Stage.</p>", - "required" : [ "StageName", "ApiId" ] + "documentation": "<p>Updates a Stage.</p>", + "required": [ + "StageName", + "ApiId" + ] }, - "UpdateStageResponse" : { - "type" : "structure", - "members" : { - "AccessLogSettings" : { - "shape" : "AccessLogSettings", - "locationName" : "accessLogSettings", - "documentation" : "<p>Settings for logging access in this stage.</p>" + "UpdateStageResponse": { + "type": "structure", + "members": { + "AccessLogSettings": { + "shape": "AccessLogSettings", + "locationName": "accessLogSettings", + "documentation": "<p>Settings for logging access in this stage.</p>" }, - "ApiGatewayManaged" : { - "shape" : "__boolean", - "locationName" : "apiGatewayManaged", - "documentation" : "<p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>" + "ApiGatewayManaged": { + "shape": "__boolean", + "locationName": "apiGatewayManaged", + "documentation": "<p>Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.</p>" }, - "AutoDeploy" : { - "shape" : "__boolean", - "locationName" : "autoDeploy", - "documentation" : "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" + "AutoDeploy": { + "shape": "__boolean", + "locationName": "autoDeploy", + "documentation": "<p>Specifies whether updates to an API automatically trigger a new deployment. The default value is false.</p>" }, - "ClientCertificateId" : { - "shape" : "Id", - "locationName" : "clientCertificateId", - "documentation" : "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" + "ClientCertificateId": { + "shape": "Id", + "locationName": "clientCertificateId", + "documentation": "<p>The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.</p>" }, - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the stage was created.</p>" + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the stage was created.</p>" }, - "DefaultRouteSettings" : { - "shape" : "RouteSettings", - "locationName" : "defaultRouteSettings", - "documentation" : "<p>Default route settings for the stage.</p>" + "DefaultRouteSettings": { + "shape": "RouteSettings", + "locationName": "defaultRouteSettings", + "documentation": "<p>Default route settings for the stage.</p>" }, - "DeploymentId" : { - "shape" : "Id", - "locationName" : "deploymentId", - "documentation" : "<p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>" + "DeploymentId": { + "shape": "Id", + "locationName": "deploymentId", + "documentation": "<p>The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.</p>" }, - "Description" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "description", - "documentation" : "<p>The description of the stage.</p>" + "Description": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "description", + "documentation": "<p>The description of the stage.</p>" }, - "LastDeploymentStatusMessage" : { - "shape" : "__string", - "locationName" : "lastDeploymentStatusMessage", - "documentation" : "<p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>" + "LastDeploymentStatusMessage": { + "shape": "__string", + "locationName": "lastDeploymentStatusMessage", + "documentation": "<p>Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.</p>" }, - "LastUpdatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "lastUpdatedDate", - "documentation" : "<p>The timestamp when the stage was last updated.</p>" + "LastUpdatedDate": { + "shape": "__timestampIso8601", + "locationName": "lastUpdatedDate", + "documentation": "<p>The timestamp when the stage was last updated.</p>" }, - "RouteSettings" : { - "shape" : "RouteSettingsMap", - "locationName" : "routeSettings", - "documentation" : "<p>Route settings for the stage, by routeKey.</p>" + "RouteSettings": { + "shape": "RouteSettingsMap", + "locationName": "routeSettings", + "documentation": "<p>Route settings for the stage, by routeKey.</p>" }, - "StageName" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "stageName", - "documentation" : "<p>The name of the stage.</p>" + "StageName": { + "shape": "StringWithLengthBetween1And128", + "locationName": "stageName", + "documentation": "<p>The name of the stage.</p>" }, - "StageVariables" : { - "shape" : "StageVariablesMap", - "locationName" : "stageVariables", - "documentation" : "<p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" + "StageVariables": { + "shape": "StageVariablesMap", + "locationName": "stageVariables", + "documentation": "<p>A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>The collection of tags. Each tag element is associated with a given resource.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>The collection of tags. Each tag element is associated with a given resource.</p>" } } }, - "UpdateVpcLinkInput" : { - "type" : "structure", - "members" : { - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the VPC link.</p>" + "UpdateVpcLinkInput": { + "type": "structure", + "members": { + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the VPC link.</p>" } }, - "documentation" : "<p>Represents the input parameters for an UpdateVpcLink request.</p>" + "documentation": "<p>Represents the input parameters for an UpdateVpcLink request.</p>" }, - "UpdateVpcLinkRequest" : { - "type" : "structure", - "members" : { - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the VPC link.</p>" + "UpdateVpcLinkRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the VPC link.</p>" }, - "VpcLinkId" : { - "shape" : "__string", - "location" : "uri", - "locationName" : "vpcLinkId", - "documentation" : "<p>The ID of the VPC link.</p>" + "VpcLinkId": { + "shape": "__string", + "location": "uri", + "locationName": "vpcLinkId", + "documentation": "<p>The ID of the VPC link.</p>" } }, - "documentation" : "<p>Updates a VPC link.</p>", - "required" : [ "VpcLinkId" ] + "documentation": "<p>Updates a VPC link.</p>", + "required": [ + "VpcLinkId" + ] }, - "UpdateVpcLinkResponse" : { - "type" : "structure", - "members" : { - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the VPC link was created.</p>" + "UpdateVpcLinkResponse": { + "type": "structure", + "members": { + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the VPC link was created.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the VPC link.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the VPC link.</p>" }, - "SecurityGroupIds" : { - "shape" : "SecurityGroupIdList", - "locationName" : "securityGroupIds", - "documentation" : "<p>A list of security group IDs for the VPC link.</p>" + "SecurityGroupIds": { + "shape": "SecurityGroupIdList", + "locationName": "securityGroupIds", + "documentation": "<p>A list of security group IDs for the VPC link.</p>" }, - "SubnetIds" : { - "shape" : "SubnetIdList", - "locationName" : "subnetIds", - "documentation" : "<p>A list of subnet IDs to include in the VPC link.</p>" + "SubnetIds": { + "shape": "SubnetIdList", + "locationName": "subnetIds", + "documentation": "<p>A list of subnet IDs to include in the VPC link.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>Tags for the VPC link.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>Tags for the VPC link.</p>" }, - "VpcLinkId" : { - "shape" : "Id", - "locationName" : "vpcLinkId", - "documentation" : "<p>The ID of the VPC link.</p>" + "VpcLinkId": { + "shape": "Id", + "locationName": "vpcLinkId", + "documentation": "<p>The ID of the VPC link.</p>" }, - "VpcLinkStatus" : { - "shape" : "VpcLinkStatus", - "locationName" : "vpcLinkStatus", - "documentation" : "<p>The status of the VPC link.</p>" + "VpcLinkStatus": { + "shape": "VpcLinkStatus", + "locationName": "vpcLinkStatus", + "documentation": "<p>The status of the VPC link.</p>" }, - "VpcLinkStatusMessage" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "vpcLinkStatusMessage", - "documentation" : "<p>A message summarizing the cause of the status of the VPC link.</p>" + "VpcLinkStatusMessage": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "vpcLinkStatusMessage", + "documentation": "<p>A message summarizing the cause of the status of the VPC link.</p>" }, - "VpcLinkVersion" : { - "shape" : "VpcLinkVersion", - "locationName" : "vpcLinkVersion", - "documentation" : "<p>The version of the VPC link.</p>" + "VpcLinkVersion": { + "shape": "VpcLinkVersion", + "locationName": "vpcLinkVersion", + "documentation": "<p>The version of the VPC link.</p>" } } }, - "UriWithLengthBetween1And2048" : { - "type" : "string", - "documentation" : "<p>A string representation of a URI with a length between [1-2048].</p>" + "UriWithLengthBetween1And2048": { + "type": "string", + "documentation": "<p>A string representation of a URI with a length between [1-2048].</p>" }, - "VpcLink" : { - "type" : "structure", - "members" : { - "CreatedDate" : { - "shape" : "__timestampIso8601", - "locationName" : "createdDate", - "documentation" : "<p>The timestamp when the VPC link was created.</p>" + "VpcLink": { + "type": "structure", + "members": { + "CreatedDate": { + "shape": "__timestampIso8601", + "locationName": "createdDate", + "documentation": "<p>The timestamp when the VPC link was created.</p>" }, - "Name" : { - "shape" : "StringWithLengthBetween1And128", - "locationName" : "name", - "documentation" : "<p>The name of the VPC link.</p>" + "Name": { + "shape": "StringWithLengthBetween1And128", + "locationName": "name", + "documentation": "<p>The name of the VPC link.</p>" }, - "SecurityGroupIds" : { - "shape" : "SecurityGroupIdList", - "locationName" : "securityGroupIds", - "documentation" : "<p>A list of security group IDs for the VPC link.</p>" + "SecurityGroupIds": { + "shape": "SecurityGroupIdList", + "locationName": "securityGroupIds", + "documentation": "<p>A list of security group IDs for the VPC link.</p>" }, - "SubnetIds" : { - "shape" : "SubnetIdList", - "locationName" : "subnetIds", - "documentation" : "<p>A list of subnet IDs to include in the VPC link.</p>" + "SubnetIds": { + "shape": "SubnetIdList", + "locationName": "subnetIds", + "documentation": "<p>A list of subnet IDs to include in the VPC link.</p>" }, - "Tags" : { - "shape" : "Tags", - "locationName" : "tags", - "documentation" : "<p>Tags for the VPC link.</p>" + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "<p>Tags for the VPC link.</p>" }, - "VpcLinkId" : { - "shape" : "Id", - "locationName" : "vpcLinkId", - "documentation" : "<p>The ID of the VPC link.</p>" + "VpcLinkId": { + "shape": "Id", + "locationName": "vpcLinkId", + "documentation": "<p>The ID of the VPC link.</p>" }, - "VpcLinkStatus" : { - "shape" : "VpcLinkStatus", - "locationName" : "vpcLinkStatus", - "documentation" : "<p>The status of the VPC link.</p>" + "VpcLinkStatus": { + "shape": "VpcLinkStatus", + "locationName": "vpcLinkStatus", + "documentation": "<p>The status of the VPC link.</p>" }, - "VpcLinkStatusMessage" : { - "shape" : "StringWithLengthBetween0And1024", - "locationName" : "vpcLinkStatusMessage", - "documentation" : "<p>A message summarizing the cause of the status of the VPC link.</p>" + "VpcLinkStatusMessage": { + "shape": "StringWithLengthBetween0And1024", + "locationName": "vpcLinkStatusMessage", + "documentation": "<p>A message summarizing the cause of the status of the VPC link.</p>" }, - "VpcLinkVersion" : { - "shape" : "VpcLinkVersion", - "locationName" : "vpcLinkVersion", - "documentation" : "<p>The version of the VPC link.</p>" + "VpcLinkVersion": { + "shape": "VpcLinkVersion", + "locationName": "vpcLinkVersion", + "documentation": "<p>The version of the VPC link.</p>" } }, - "documentation" : "<p>Represents a VPC link.</p>", - "required" : [ "VpcLinkId", "SecurityGroupIds", "SubnetIds", "Name" ] + "documentation": "<p>Represents a VPC link.</p>", + "required": [ + "VpcLinkId", + "SecurityGroupIds", + "SubnetIds", + "Name" + ] }, - "VpcLinkStatus" : { - "type" : "string", - "documentation" : "<p>The status of the VPC link.</p>", - "enum" : [ "PENDING", "AVAILABLE", "DELETING", "FAILED", "INACTIVE" ] + "VpcLinkStatus": { + "type": "string", + "documentation": "<p>The status of the VPC link.</p>", + "enum": [ + "PENDING", + "AVAILABLE", + "DELETING", + "FAILED", + "INACTIVE" + ] }, - "VpcLinkVersion" : { - "type" : "string", - "documentation" : "<p>The version of the VPC link.</p>", - "enum" : [ "V2" ] + "VpcLinkVersion": { + "type": "string", + "documentation": "<p>The version of the VPC link.</p>", + "enum": [ + "V2" + ] }, - "VpcLinks" : { - "type" : "structure", - "members" : { - "Items" : { - "shape" : "__listOfVpcLink", - "locationName" : "items", - "documentation" : "<p>A collection of VPC links.</p>" + "VpcLinks": { + "type": "structure", + "members": { + "Items": { + "shape": "__listOfVpcLink", + "locationName": "items", + "documentation": "<p>A collection of VPC links.</p>" }, - "NextToken" : { - "shape" : "NextToken", - "locationName" : "nextToken", - "documentation" : "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" + "NextToken": { + "shape": "NextToken", + "locationName": "nextToken", + "documentation": "<p>The next page of elements from this collection. Not valid for the last element of the collection.</p>" } }, - "documentation" : "<p>Represents a collection of VPCLinks.</p>" + "documentation": "<p>Represents a collection of VPCLinks.</p>" }, - "__boolean" : { - "type" : "boolean" + "__boolean": { + "type": "boolean" }, - "__double" : { - "type" : "double" + "__double": { + "type": "double" }, - "__integer" : { - "type" : "integer" + "__integer": { + "type": "integer" }, - "__listOfApi" : { - "type" : "list", - "member" : { - "shape" : "Api" + "__listOfApi": { + "type": "list", + "member": { + "shape": "Api" } }, - "__listOfApiMapping" : { - "type" : "list", - "member" : { - "shape" : "ApiMapping" + "__listOfApiMapping": { + "type": "list", + "member": { + "shape": "ApiMapping" } }, - "__listOfAuthorizer" : { - "type" : "list", - "member" : { - "shape" : "Authorizer" + "__listOfAuthorizer": { + "type": "list", + "member": { + "shape": "Authorizer" } }, - "__listOfDeployment" : { - "type" : "list", - "member" : { - "shape" : "Deployment" + "__listOfDeployment": { + "type": "list", + "member": { + "shape": "Deployment" } }, - "__listOfDomainName" : { - "type" : "list", - "member" : { - "shape" : "DomainName" + "__listOfDomainName": { + "type": "list", + "member": { + "shape": "DomainName" } }, - "__listOfIntegration" : { - "type" : "list", - "member" : { - "shape" : "Integration" + "__listOfIntegration": { + "type": "list", + "member": { + "shape": "Integration" } }, - "__listOfIntegrationResponse" : { - "type" : "list", - "member" : { - "shape" : "IntegrationResponse" + "__listOfIntegrationResponse": { + "type": "list", + "member": { + "shape": "IntegrationResponse" } }, - "__listOfModel" : { - "type" : "list", - "member" : { - "shape" : "Model" + "__listOfModel": { + "type": "list", + "member": { + "shape": "Model" } }, - "__listOfRoute" : { - "type" : "list", - "member" : { - "shape" : "Route" + "__listOfRoute": { + "type": "list", + "member": { + "shape": "Route" } }, - "__listOfRouteResponse" : { - "type" : "list", - "member" : { - "shape" : "RouteResponse" + "__listOfRouteResponse": { + "type": "list", + "member": { + "shape": "RouteResponse" } }, - "__listOfStage" : { - "type" : "list", - "member" : { - "shape" : "Stage" + "__listOfStage": { + "type": "list", + "member": { + "shape": "Stage" } }, - "__listOfVpcLink" : { - "type" : "list", - "member" : { - "shape" : "VpcLink" + "__listOfVpcLink": { + "type": "list", + "member": { + "shape": "VpcLink" } }, - "__listOf__string" : { - "type" : "list", - "member" : { - "shape" : "__string" + "__listOf__string": { + "type": "list", + "member": { + "shape": "__string" } }, - "__long" : { - "type" : "long" + "__long": { + "type": "long" }, - "__string" : { - "type" : "string" + "__string": { + "type": "string" }, - "__timestampIso8601" : { - "type" : "timestamp", - "timestampFormat" : "iso8601" + "__timestampIso8601": { + "type": "timestamp", + "timestampFormat": "iso8601" }, - "__timestampUnix" : { - "type" : "timestamp", - "timestampFormat" : "unixTimestamp" + "__timestampUnix": { + "type": "timestamp", + "timestampFormat": "unixTimestamp" } }, - "documentation" : "<p>Amazon API Gateway V2</p>" -} + "documentation": "<p>Amazon API Gateway V2</p>" +}
\ No newline at end of file diff --git a/contrib/python/botocore/py3/botocore/data/appstream/2016-12-01/service-2.json b/contrib/python/botocore/py3/botocore/data/appstream/2016-12-01/service-2.json index 04e2309b131..dd83fb97cc5 100644 --- a/contrib/python/botocore/py3/botocore/data/appstream/2016-12-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/appstream/2016-12-01/service-2.json @@ -1154,7 +1154,8 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"}, {"shape":"OperationNotPermittedException"}, - {"shape":"InvalidRoleException"} + {"shape":"InvalidRoleException"}, + {"shape":"IncompatibleImageException"} ], "documentation":"<p>Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>" }, @@ -5041,6 +5042,10 @@ "Domains":{ "shape":"DomainList", "documentation":"<p>The names of the domains for the account.</p>" + }, + "DomainsRequireAdminConsent":{ + "shape":"DomainList", + "documentation":"<p>The OneDrive for Business domains where you require admin consent when users try to link their OneDrive account to AppStream 2.0. The attribute can only be specified when ConnectorType=ONE_DRIVE.</p>" } }, "documentation":"<p>Describes a connector that enables persistent storage for users.</p>" diff --git a/contrib/python/botocore/py3/botocore/data/appsync/2017-07-25/service-2.json b/contrib/python/botocore/py3/botocore/data/appsync/2017-07-25/service-2.json index dfc9fae8d06..3925e7487e0 100644 --- a/contrib/python/botocore/py3/botocore/data/appsync/2017-07-25/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/appsync/2017-07-25/service-2.json @@ -1372,7 +1372,7 @@ }, "apiCachingBehavior":{ "shape":"ApiCachingBehavior", - "documentation":"<p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</p> </li> </ul>" + "documentation":"<p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</p> </li> <li> <p> <b>OPERATION_LEVEL_CACHING</b>: Full requests are cached together and returned without executing resolvers.</p> </li> </ul>" }, "transitEncryptionEnabled":{ "shape":"Boolean", @@ -1431,7 +1431,8 @@ "type":"string", "enum":[ "FULL_REQUEST_CACHING", - "PER_RESOLVER_CACHING" + "PER_RESOLVER_CACHING", + "OPERATION_LEVEL_CACHING" ] }, "ApiKey":{ @@ -1967,7 +1968,7 @@ }, "apiCachingBehavior":{ "shape":"ApiCachingBehavior", - "documentation":"<p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</p> </li> </ul>" + "documentation":"<p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</p> </li> <li> <p> <b>OPERATION_LEVEL_CACHING</b>: Full requests are cached together and returned without executing resolvers.</p> </li> </ul>" }, "type":{ "shape":"ApiCacheType", @@ -3189,6 +3190,14 @@ "logs":{ "shape":"Logs", "documentation":"<p>A list of logs that were generated by calls to <code>util.log.info</code> and <code>util.log.error</code> in the evaluated code.</p>" + }, + "stash":{ + "shape":"Stash", + "documentation":"<p>An object available inside each resolver and function handler. A single <code>stash</code> object lives through a single resolver run. Therefore, you can use the stash to pass arbitrary data across request and response handlers and across functions in a pipeline resolver.</p>" + }, + "outErrors":{ + "shape":"OutErrors", + "documentation":"<p>The list of runtime errors that are added to the GraphQL operation response.</p>" } } }, @@ -3223,6 +3232,14 @@ "logs":{ "shape":"Logs", "documentation":"<p>A list of logs that were generated by calls to <code>util.log.info</code> and <code>util.log.error</code> in the evaluated code.</p>" + }, + "stash":{ + "shape":"Stash", + "documentation":"<p>An object available inside each resolver and function handler. A single <code>stash</code> object lives through a single resolver run. Therefore, you can use the stash to pass arbitrary data across request and response handlers and across functions in a pipeline resolver.</p>" + }, + "outErrors":{ + "shape":"OutErrors", + "documentation":"<p>The list of runtime errors that are added to the GraphQL operation response.</p>" } } }, @@ -4645,6 +4662,10 @@ "DISABLED" ] }, + "OutErrors":{ + "type":"string", + "pattern":"^[\\s\\S]*$" + }, "OutputType":{ "type":"string", "enum":[ @@ -5118,6 +5139,10 @@ } } }, + "Stash":{ + "type":"string", + "pattern":"^[\\s\\S]*$" + }, "String":{"type":"string"}, "SyncConfig":{ "type":"structure", @@ -5293,7 +5318,7 @@ }, "apiCachingBehavior":{ "shape":"ApiCachingBehavior", - "documentation":"<p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests are fully cached.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</p> </li> </ul>" + "documentation":"<p>Caching behavior.</p> <ul> <li> <p> <b>FULL_REQUEST_CACHING</b>: All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.</p> </li> <li> <p> <b>PER_RESOLVER_CACHING</b>: Individual resolvers that you specify are cached.</p> </li> <li> <p> <b>OPERATION_LEVEL_CACHING</b>: Full requests are cached together and returned without executing resolvers.</p> </li> </ul>" }, "type":{ "shape":"ApiCacheType", diff --git a/contrib/python/botocore/py3/botocore/data/b2bi/2022-06-23/service-2.json b/contrib/python/botocore/py3/botocore/data/b2bi/2022-06-23/service-2.json index 579378aac52..3a8386c71f1 100644 --- a/contrib/python/botocore/py3/botocore/data/b2bi/2022-06-23/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/b2bi/2022-06-23/service-2.json @@ -2859,13 +2859,13 @@ "type":"string", "max":15, "min":2, - "pattern":"[a-zA-Z0-9]*" + "pattern":"[a-zA-Z0-9 ]*" }, "X12ApplicationSenderCode":{ "type":"string", "max":15, "min":2, - "pattern":"[a-zA-Z0-9]*" + "pattern":"[a-zA-Z0-9 ]*" }, "X12ComponentSeparator":{ "type":"string", @@ -3005,7 +3005,7 @@ "type":"string", "max":15, "min":15, - "pattern":"[a-zA-Z0-9]*" + "pattern":"[a-zA-Z0-9 ]*" }, "X12RepetitionSeparator":{ "type":"string", @@ -3028,7 +3028,7 @@ "type":"string", "max":15, "min":15, - "pattern":"[a-zA-Z0-9]*" + "pattern":"[a-zA-Z0-9 ]*" }, "X12TransactionSet":{ "type":"string", diff --git a/contrib/python/botocore/py3/botocore/data/batch/2016-08-10/service-2.json b/contrib/python/botocore/py3/botocore/data/batch/2016-08-10/service-2.json index 2f2550a1f22..38fc2c3c3de 100644 --- a/contrib/python/botocore/py3/botocore/data/batch/2016-08-10/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/batch/2016-08-10/service-2.json @@ -278,7 +278,7 @@ {"shape":"ClientException"}, {"shape":"ServerException"} ], - "documentation":"<p>Submits an Batch job from a job definition. Parameters that are specified during <a>SubmitJob</a> override parameters defined in the job definition. vCPU and memory requirements that are specified in the <code>resourceRequirements</code> objects in the job definition are the exception. They can't be overridden this way using the <code>memory</code> and <code>vcpus</code> parameters. Rather, you must specify updates to job definition parameters in a <code>resourceRequirements</code> object that's included in the <code>containerOverrides</code> parameter.</p> <note> <p>Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time. </p> </note> <important> <p>Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.</p> </important>" + "documentation":"<p>Submits an Batch job from a job definition. Parameters that are specified during <a>SubmitJob</a> override parameters defined in the job definition. vCPU and memory requirements that are specified in the <code>resourceRequirements</code> objects in the job definition are the exception. They can't be overridden this way using the <code>memory</code> and <code>vcpus</code> parameters. Rather, you must specify updates to job definition parameters in a <code>resourceRequirements</code> object that's included in the <code>containerOverrides</code> parameter.</p> <note> <p>Job queues with a scheduling policy are limited to 500 active share identifiers at a time. </p> </note> <important> <p>Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.</p> </important>" }, "TagResource":{ "name":"TagResource", @@ -1163,7 +1163,7 @@ }, "unmanagedvCpus":{ "shape":"Integer", - "documentation":"<p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.</p> <note> <p>This parameter is only supported when the <code>type</code> parameter is set to <code>UNMANAGED</code>.</p> </note>" + "documentation":"<p>The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.</p> <note> <p>This parameter is only supported when the <code>type</code> parameter is set to <code>UNMANAGED</code>.</p> </note>" }, "computeResources":{ "shape":"ComputeResource", @@ -1219,7 +1219,7 @@ }, "schedulingPolicyArn":{ "shape":"String", - "documentation":"<p>The Amazon Resource Name (ARN) of the fair share scheduling policy. Job queues that don't have a scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a scheduling policy, it can be replaced but can't be removed.</p> <p>The format is <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i> </code>.</p> <p>An example is <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p> <p>A job queue without a scheduling policy is scheduled as a FIFO job queue and can't have a scheduling policy added. Jobs queues with a scheduling policy can have a maximum of 500 active fair share identifiers. When the limit has been reached, submissions of any jobs that add a new fair share identifier fail.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the fair-share scheduling policy. Job queues that don't have a fair-share scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a fair-share scheduling policy, it can be replaced but can't be removed.</p> <p>The format is <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i> </code>.</p> <p>An example is <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p> <p>A job queue without a fair-share scheduling policy is scheduled as a FIFO job queue and can't have a fair-share scheduling policy added. Jobs queues with a fair-share scheduling policy can have a maximum of 500 active share identifiers. When the limit has been reached, submissions of any jobs that add a new share identifier fail.</p>" }, "priority":{ "shape":"Integer", @@ -1263,11 +1263,11 @@ "members":{ "name":{ "shape":"String", - "documentation":"<p>The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>" + "documentation":"<p>The name of the fair-share scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).</p>" }, "fairsharePolicy":{ "shape":"FairsharePolicy", - "documentation":"<p>The fair share policy of the scheduling policy.</p>" + "documentation":"<p>The fair-share scheduling policy details.</p>" }, "tags":{ "shape":"TagrisTagsMap", @@ -2229,7 +2229,7 @@ }, "initContainers":{ "shape":"EksContainerOverrideList", - "documentation":"<p>The overrides for the <code>initContainers</code> defined in the Amazon EKS pod. These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see <a href=\"https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\">Init Containers</a> in the <i>Kubernetes documentation</i>.</p>" + "documentation":"<p>The overrides for the <code>initContainers</code> defined in the Amazon EKS pod. These containers run before application containers, always run to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see <a href=\"https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\">Init Containers</a> in the <i>Kubernetes documentation</i>.</p>" }, "metadata":{ "shape":"EksMetadata", @@ -2366,18 +2366,18 @@ "members":{ "shareDecaySeconds":{ "shape":"Integer", - "documentation":"<p>The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).</p>" + "documentation":"<p>The amount of time (in seconds) to use to calculate a fair-share percentage for each share identifier in use. A value of zero (0) indicates the default minimum time window (600 seconds). The maximum supported value is 604800 (1 week).</p> <p>The decay allows for more recently run jobs to have more weight than jobs that ran earlier. Consider adjusting this number if you have jobs that (on average) run longer than ten minutes, or a large difference in job count or job run times between share identifiers, and the allocation of resources doesn’t meet your needs.</p>" }, "computeReservation":{ "shape":"Integer", - "documentation":"<p>A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.</p> <p>The reserved ratio is <code>(<i>computeReservation</i>/100)^<i>ActiveFairShares</i> </code> where <code> <i>ActiveFairShares</i> </code> is the number of active fair share identifiers.</p> <p>For example, a <code>computeReservation</code> value of 50 indicates that Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. A <code>computeReservation</code> value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.</p> <p>The minimum value is 0 and the maximum value is 99.</p>" + "documentation":"<p>A value used to reserve some of the available maximum vCPU for share identifiers that aren't already used.</p> <p>The reserved ratio is <code>(<i>computeReservation</i>/100)^<i>ActiveFairShares</i> </code> where <code> <i>ActiveFairShares</i> </code> is the number of active share identifiers.</p> <p>For example, a <code>computeReservation</code> value of 50 indicates that Batch reserves 50% of the maximum available vCPU if there's only one share identifier. It reserves 25% if there are two share identifiers. It reserves 12.5% if there are three share identifiers. A <code>computeReservation</code> value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there's only one share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three share identifiers.</p> <p>The minimum value is 0 and the maximum value is 99.</p>" }, "shareDistribution":{ "shape":"ShareAttributesList", - "documentation":"<p>An array of <code>SharedIdentifier</code> objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of <code>1.0</code>.</p>" + "documentation":"<p>An array of <code>SharedIdentifier</code> objects that contain the weights for the share identifiers for the fair-share policy. Share identifiers that aren't included have a default weight of <code>1.0</code>.</p>" } }, - "documentation":"<p>The fair share policy for a scheduling policy.</p>" + "documentation":"<p>The fair-share scheduling policy details.</p>" }, "FargatePlatformConfiguration":{ "type":"structure", @@ -2395,7 +2395,7 @@ "members":{ "jobs":{ "shape":"FrontOfQueueJobSummaryList", - "documentation":"<p>The Amazon Resource Names (ARNs) of the first 100 <code>RUNNABLE</code> jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>" + "documentation":"<p>The Amazon Resource Names (ARNs) of the first 100 <code>RUNNABLE</code> jobs in a named job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>" }, "lastUpdatedAt":{ "shape":"Long", @@ -2437,7 +2437,7 @@ "members":{ "frontOfQueue":{ "shape":"FrontOfQueueDetail", - "documentation":"<p>The list of the first 100 <code>RUNNABLE</code> jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>" + "documentation":"<p>The list of the first 100 <code>RUNNABLE</code> jobs in each job queue. For first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair-share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.</p>" } } }, @@ -2526,7 +2526,7 @@ }, "schedulingPriority":{ "shape":"Integer", - "documentation":"<p>The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.</p>" + "documentation":"<p>The scheduling priority of the job definition. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.</p>" }, "parameters":{ "shape":"ParametersMap", @@ -2641,7 +2641,7 @@ }, "schedulingPriority":{ "shape":"Integer", - "documentation":"<p>The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.</p>" + "documentation":"<p>The scheduling policy of the job definition. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.</p>" }, "attempts":{ "shape":"AttemptDetails", @@ -2779,7 +2779,7 @@ }, "priority":{ "shape":"Integer", - "documentation":"<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>. All of the compute environments must be either Amazon EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and Fargate compute environments can't be mixed.</p>" + "documentation":"<p>The priority of the job queue. Job queue priority determines the order that job queues are evaluated when multiple queues dispatch jobs within a shared compute environment. A higher value for <code>priority</code> indicates a higher priority. Queues are evaluated in cycles, in descending order by priority. For example, a job queue with a priority value of <code>10</code> is evaluated before a queue with a priority value of <code>1</code>. All of the compute environments must be either Amazon EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and Fargate compute environments can't be mixed.</p> <note> <p>Job queue priority doesn't guarantee that a particular job executes before a job in a lower priority queue. Jobs added to higher priority queues during the queue evaluation cycle might not be evaluated until the next cycle. A job is dispatched from a queue only if resources are available when the queue is evaluated. If there are insufficient resources available at that time, the cycle proceeds to the next queue. This means that jobs added to higher priority queues might have to wait for jobs in multiple lower priority queues to complete before they are dispatched. You can use job dependencies to control the order for jobs from queues with different priorities. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/job_dependencies.html\">Job Dependencies</a> in the <i>Batch User Guide</i>.</p> </note>" }, "computeEnvironmentOrder":{ "shape":"ComputeEnvironmentOrders", @@ -2996,7 +2996,7 @@ }, "targetInstanceTypes":{ "shape":"StringList", - "documentation":"<p>The instance type or family that this this override launch template should be applied to.</p> <p>This parameter is required when defining a launch template override.</p> <p>Information included in this parameter must meet the following requirements:</p> <ul> <li> <p>Must be a valid Amazon EC2 instance type or family.</p> </li> <li> <p> <code>optimal</code> isn't allowed.</p> </li> <li> <p> <code>targetInstanceTypes</code> can target only instance types and families that are included within the <a href=\"https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-instanceTypes\"> <code>ComputeResource.instanceTypes</code> </a> set. <code>targetInstanceTypes</code> doesn't need to include all of the instances from the <code>instanceType</code> set, but at least a subset. For example, if <code>ComputeResource.instanceTypes</code> includes <code>[m5, g5]</code>, <code>targetInstanceTypes</code> can include <code>[m5.2xlarge]</code> and <code>[m5.large]</code> but not <code>[c5.large]</code>.</p> </li> <li> <p> <code>targetInstanceTypes</code> included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.</p> </li> </ul>" + "documentation":"<p>The instance type or family that this override launch template should be applied to.</p> <p>This parameter is required when defining a launch template override.</p> <p>Information included in this parameter must meet the following requirements:</p> <ul> <li> <p>Must be a valid Amazon EC2 instance type or family.</p> </li> <li> <p> <code>optimal</code> isn't allowed.</p> </li> <li> <p> <code>targetInstanceTypes</code> can target only instance types and families that are included within the <a href=\"https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-instanceTypes\"> <code>ComputeResource.instanceTypes</code> </a> set. <code>targetInstanceTypes</code> doesn't need to include all of the instances from the <code>instanceType</code> set, but at least a subset. For example, if <code>ComputeResource.instanceTypes</code> includes <code>[m5, g5]</code>, <code>targetInstanceTypes</code> can include <code>[m5.2xlarge]</code> and <code>[m5.large]</code> but not <code>[c5.large]</code>.</p> </li> <li> <p> <code>targetInstanceTypes</code> included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.</p> </li> </ul>" } }, "documentation":"<p>An object that represents a launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.</p> <p>If security groups are specified using both the <code>securityGroupIds</code> parameter of <code>CreateComputeEnvironment</code> and the launch template, the values in the <code>securityGroupIds</code> parameter of <code>CreateComputeEnvironment</code> will be used.</p> <p>You can define up to ten (10) overrides for each compute environment.</p> <note> <p>This object isn't applicable to jobs that are running on Fargate resources.</p> </note> <note> <p>To unset all override templates for a compute environment, you can pass an empty array to the <a href=\"https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html\">UpdateComputeEnvironment.overrides</a> parameter, or not include the <code>overrides</code> parameter when submitting the <code>UpdateComputeEnvironment</code> API operation.</p> </note>" @@ -3026,7 +3026,7 @@ }, "maxSwap":{ "shape":"Integer", - "documentation":"<p>The total amount of swap memory (in MiB) a container can use. This parameter is translated to the <code>--memory-swap</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a> where the value is the sum of the container memory plus the <code>maxSwap</code> value. For more information, see <a href=\"https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details\"> <code>--memory-swap</code> details</a> in the Docker documentation.</p> <p>If a <code>maxSwap</code> value of <code>0</code> is specified, the container doesn't use swap. Accepted values are <code>0</code> or any positive integer. If the <code>maxSwap</code> parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A <code>maxSwap</code> value must be set for the <code>swappiness</code> parameter to be used.</p> <note> <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.</p> </note>" + "documentation":"<p>The total amount of swap memory (in MiB) a container can use. This parameter is translated to the <code>--memory-swap</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a> where the value is the sum of the container memory plus the <code>maxSwap</code> value. For more information, see <a href=\"https://docs.docker.com/config/containers/resource_constraints/#--memory-swap-details\"> <code>--memory-swap</code> details</a> in the Docker documentation.</p> <p>If a <code>maxSwap</code> value of <code>0</code> is specified, the container doesn't use swap. Accepted values are <code>0</code> or any positive integer. If the <code>maxSwap</code> parameter is omitted, the container doesn't use the swap configuration for the container instance on which it runs. A <code>maxSwap</code> value must be set for the <code>swappiness</code> parameter to be used.</p> <note> <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.</p> </note>" }, "swappiness":{ "shape":"Integer", @@ -3439,7 +3439,7 @@ }, "schedulingPriority":{ "shape":"Integer", - "documentation":"<p>The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.</p> <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>" + "documentation":"<p>The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.</p> <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>" }, "containerProperties":{ "shape":"ContainerProperties", @@ -3587,7 +3587,7 @@ "members":{ "name":{ "shape":"String", - "documentation":"<p>The name of the scheduling policy.</p>" + "documentation":"<p>The name of the fair-share scheduling policy.</p>" }, "arn":{ "shape":"String", @@ -3595,11 +3595,11 @@ }, "fairsharePolicy":{ "shape":"FairsharePolicy", - "documentation":"<p>The fair share policy for the scheduling policy.</p>" + "documentation":"<p>The fair-share scheduling policy details.</p>" }, "tags":{ "shape":"TagrisTagsMap", - "documentation":"<p>The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in <i>Amazon Web Services General Reference</i>.</p>" + "documentation":"<p>The tags that you apply to the fair-share scheduling policy to categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in <i>Amazon Web Services General Reference</i>.</p>" } }, "documentation":"<p>An object that represents a scheduling policy.</p>" @@ -3661,14 +3661,14 @@ "members":{ "shareIdentifier":{ "shape":"String", - "documentation":"<p>A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share identifiers in a fair share policy can't overlap. For example, you can't have one that specifies a <code>shareIdentifier</code> of <code>UserA*</code> and another that specifies a <code>shareIdentifier</code> of <code>UserA-1</code>.</p> <p>There can be no more than 500 fair share identifiers active in a job queue.</p> <p>The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).</p>" + "documentation":"<p>A share identifier or share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for share identifiers that start with that prefix. The list of share identifiers in a fair-share policy can't overlap. For example, you can't have one that specifies a <code>shareIdentifier</code> of <code>UserA*</code> and another that specifies a <code>shareIdentifier</code> of <code>UserA-1</code>.</p> <p>There can be no more than 500 share identifiers active in a job queue.</p> <p>The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).</p>" }, "weightFactor":{ "shape":"Float", - "documentation":"<p>The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1.</p> <p>The smallest supported value is 0.0001, and the largest supported value is 999.9999.</p>" + "documentation":"<p>The weight factor for the share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1.</p> <p>The smallest supported value is 0.0001, and the largest supported value is 999.9999.</p>" } }, - "documentation":"<p>Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of <code>1.0</code>.</p>" + "documentation":"<p>Specifies the weights for the share identifiers for the fair-share policy. Share identifiers that aren't included have a default weight of <code>1.0</code>.</p>" }, "ShareAttributesList":{ "type":"list", @@ -3697,11 +3697,11 @@ }, "shareIdentifier":{ "shape":"String", - "documentation":"<p>The share identifier for the job. Don't specify this parameter if the job queue doesn't have a scheduling policy. If the job queue has a scheduling policy, then this parameter must be specified.</p> <p>This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).</p>" + "documentation":"<p>The share identifier for the job. Don't specify this parameter if the job queue doesn't have a fair-share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.</p> <p>This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).</p>" }, "schedulingPriorityOverride":{ "shape":"Integer", - "documentation":"<p>The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition and works only within a single share identifier.</p> <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>" + "documentation":"<p>The scheduling priority for the job. This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition and works only within a single share identifier.</p> <p>The minimum supported value is 0 and the maximum supported value is 9999.</p>" }, "arrayProperties":{ "shape":"ArrayProperties", @@ -3967,7 +3967,7 @@ }, "environment":{ "shape":"EnvironmentVariables", - "documentation":"<p>The environment variables to pass to a container. This parameter maps to Env inthe <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--env</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p> <important> <p>We don't recommend using plaintext environment variables for sensitive information, such as credential data.</p> </important> <note> <p>Environment variables cannot start with <code>AWS_BATCH</code>. This naming convention is reserved for variables that Batch sets.</p> </note>" + "documentation":"<p>The environment variables to pass to a container. This parameter maps to Env in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--env</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p> <important> <p>We don't recommend using plaintext environment variables for sensitive information, such as credential data.</p> </important> <note> <p>Environment variables cannot start with <code>AWS_BATCH</code>. This naming convention is reserved for variables that Batch sets.</p> </note>" }, "essential":{ "shape":"Boolean", @@ -4151,7 +4151,7 @@ }, "unmanagedvCpus":{ "shape":"Integer", - "documentation":"<p>The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.</p>" + "documentation":"<p>The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.</p>" }, "computeResources":{ "shape":"ComputeResourceUpdate", @@ -4199,7 +4199,7 @@ }, "schedulingPolicyArn":{ "shape":"String", - "documentation":"<p>Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i> </code>. For example, <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>" + "documentation":"<p>Amazon Resource Name (ARN) of the fair-share scheduling policy. Once a job queue is created, the fair-share scheduling policy can be replaced but not removed. The format is <code>aws:<i>Partition</i>:batch:<i>Region</i>:<i>Account</i>:scheduling-policy/<i>Name</i> </code>. For example, <code>aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy</code>.</p>" }, "priority":{ "shape":"Integer", @@ -4253,7 +4253,7 @@ }, "fairsharePolicy":{ "shape":"FairsharePolicy", - "documentation":"<p>The fair share policy.</p>" + "documentation":"<p>The fair-share policy scheduling details.</p>" } }, "documentation":"<p>Contains the parameters for <code>UpdateSchedulingPolicy</code>.</p>" diff --git a/contrib/python/botocore/py3/botocore/data/bcm-pricing-calculator/2024-06-19/service-2.json b/contrib/python/botocore/py3/botocore/data/bcm-pricing-calculator/2024-06-19/service-2.json index 5050c0084e0..bddd2532296 100644 --- a/contrib/python/botocore/py3/botocore/data/bcm-pricing-calculator/2024-06-19/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/bcm-pricing-calculator/2024-06-19/service-2.json @@ -32,7 +32,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p> Create Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario. </p>", + "documentation":"<p> Create Compute Savings Plans, EC2 Instance Savings Plans, or EC2 Reserved Instances commitments that you want to model in a Bill Scenario. </p> <note> <p>The <code>BatchCreateBillScenarioCommitmentModification</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>bcm-pricing-calculator:CreateBillScenarioCommitmentModification</code> in your policies.</p> </note>", "idempotent":true }, "BatchCreateBillScenarioUsageModification":{ @@ -53,7 +53,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p> Create Amazon Web Services service usage that you want to model in a Bill Scenario. </p>", + "documentation":"<p> Create Amazon Web Services service usage that you want to model in a Bill Scenario. </p> <note> <p>The <code>BatchCreateBillScenarioUsageModification</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>bcm-pricing-calculator:CreateBillScenarioUsageModification</code> in your policies.</p> </note>", "idempotent":true }, "BatchCreateWorkloadEstimateUsage":{ @@ -74,7 +74,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p> Create Amazon Web Services service usage that you want to model in a Workload Estimate. </p>", + "documentation":"<p> Create Amazon Web Services service usage that you want to model in a Workload Estimate. </p> <note> <p>The <code>BatchCreateWorkloadEstimateUsage</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>bcm-pricing-calculator:CreateWorkloadEstimateUsage</code> in your policies.</p> </note>", "idempotent":true }, "BatchDeleteBillScenarioCommitmentModification":{ @@ -86,6 +86,7 @@ "input":{"shape":"BatchDeleteBillScenarioCommitmentModificationRequest"}, "output":{"shape":"BatchDeleteBillScenarioCommitmentModificationResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"DataUnavailableException"}, {"shape":"InternalServerException"}, @@ -93,7 +94,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p> Delete commitment that you have created in a Bill Scenario. You can only delete a commitment that you had added and cannot model deletion (or removal) of a existing commitment. If you want model deletion of an existing commitment, see the negate <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BillScenarioCommitmentModificationAction.html\"> BillScenarioCommitmentModificationAction</a> of <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BatchCreateBillScenarioUsageModification.html\"> BatchCreateBillScenarioCommitmentModification</a> operation. </p>", + "documentation":"<p> Delete commitment that you have created in a Bill Scenario. You can only delete a commitment that you had added and cannot model deletion (or removal) of a existing commitment. If you want model deletion of an existing commitment, see the negate <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BillScenarioCommitmentModificationAction.html\"> BillScenarioCommitmentModificationAction</a> of <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BatchCreateBillScenarioUsageModification.html\"> BatchCreateBillScenarioCommitmentModification</a> operation. </p> <note> <p>The <code>BatchDeleteBillScenarioCommitmentModification</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>bcm-pricing-calculator:DeleteBillScenarioCommitmentModification</code> in your policies.</p> </note>", "idempotent":true }, "BatchDeleteBillScenarioUsageModification":{ @@ -105,6 +106,7 @@ "input":{"shape":"BatchDeleteBillScenarioUsageModificationRequest"}, "output":{"shape":"BatchDeleteBillScenarioUsageModificationResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"DataUnavailableException"}, {"shape":"ServiceQuotaExceededException"}, @@ -113,7 +115,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p> Delete usage that you have created in a Bill Scenario. You can only delete usage that you had added and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BatchUpdateBillScenarioUsageModification.html\"> BatchUpdateBillScenarioUsageModification</a>. </p>", + "documentation":"<p> Delete usage that you have created in a Bill Scenario. You can only delete usage that you had added and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BatchUpdateBillScenarioUsageModification.html\"> BatchUpdateBillScenarioUsageModification</a>. </p> <note> <p>The <code>BatchDeleteBillScenarioUsageModification</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>bcm-pricing-calculator:DeleteBillScenarioUsageModification</code> in your policies.</p> </note>", "idempotent":true }, "BatchDeleteWorkloadEstimateUsage":{ @@ -133,7 +135,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p> Delete usage that you have created in a Workload estimate. You can only delete usage that you had added and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BatchUpdateWorkloadEstimateUsage.html\"> BatchUpdateWorkloadEstimateUsage</a>. </p>", + "documentation":"<p> Delete usage that you have created in a Workload estimate. You can only delete usage that you had added and cannot model deletion (or removal) of a existing usage. If you want model removal of an existing usage, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_AWSBCMPricingCalculator_BatchUpdateWorkloadEstimateUsage.html\"> BatchUpdateWorkloadEstimateUsage</a>. </p> <note> <p>The <code>BatchDeleteWorkloadEstimateUsage</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>bcm-pricing-calculator:DeleteWorkloadEstimateUsage</code> in your policies.</p> </note>", "idempotent":true }, "BatchUpdateBillScenarioCommitmentModification":{ @@ -145,6 +147,7 @@ "input":{"shape":"BatchUpdateBillScenarioCommitmentModificationRequest"}, "output":{"shape":"BatchUpdateBillScenarioCommitmentModificationResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"DataUnavailableException"}, {"shape":"InternalServerException"}, @@ -152,7 +155,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p> Update a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID. </p>", + "documentation":"<p> Update a newly added or existing commitment. You can update the commitment group based on a commitment ID and a Bill scenario ID. </p> <note> <p>The <code>BatchUpdateBillScenarioCommitmentModification</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>bcm-pricing-calculator:UpdateBillScenarioCommitmentModification</code> in your policies.</p> </note>", "idempotent":true }, "BatchUpdateBillScenarioUsageModification":{ @@ -164,6 +167,7 @@ "input":{"shape":"BatchUpdateBillScenarioUsageModificationRequest"}, "output":{"shape":"BatchUpdateBillScenarioUsageModificationResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"DataUnavailableException"}, {"shape":"ServiceQuotaExceededException"}, @@ -172,7 +176,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p> Update a newly added or existing usage lines. You can update the usage amounts, usage hour, and usage group based on a usage ID and a Bill scenario ID. </p>", + "documentation":"<p> Update a newly added or existing usage lines. You can update the usage amounts, usage hour, and usage group based on a usage ID and a Bill scenario ID. </p> <note> <p>The <code>BatchUpdateBillScenarioUsageModification</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>bcm-pricing-calculator:UpdateBillScenarioUsageModification</code> in your policies.</p> </note>", "idempotent":true }, "BatchUpdateWorkloadEstimateUsage":{ @@ -192,7 +196,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p> Update a newly added or existing usage lines. You can update the usage amounts and usage group based on a usage ID and a Workload estimate ID. </p>", + "documentation":"<p> Update a newly added or existing usage lines. You can update the usage amounts and usage group based on a usage ID and a Workload estimate ID. </p> <note> <p>The <code>BatchUpdateWorkloadEstimateUsage</code> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <code>bcm-pricing-calculator:UpdateWorkloadEstimateUsage</code> in your policies.</p> </note>", "idempotent":true }, "CreateBillEstimate":{ @@ -283,6 +287,7 @@ "input":{"shape":"DeleteBillScenarioRequest"}, "output":{"shape":"DeleteBillScenarioResponse"}, "errors":[ + {"shape":"ConflictException"}, {"shape":"ValidationException"}, {"shape":"DataUnavailableException"}, {"shape":"InternalServerException"}, @@ -2920,11 +2925,11 @@ }, "createdAtFilter":{ "shape":"FilterTimestamp", - "documentation":"<p> Filter bill estimates based on their creation date. </p>" + "documentation":"<p> Filter bill estimates based on the creation date. </p>" }, "expiresAtFilter":{ "shape":"FilterTimestamp", - "documentation":"<p> Filter bill estimates based on their expiration date. </p>" + "documentation":"<p> Filter bill estimates based on the expiration date. </p>" }, "nextToken":{ "shape":"NextPageToken", @@ -3061,11 +3066,11 @@ }, "createdAtFilter":{ "shape":"FilterTimestamp", - "documentation":"<p> Filter bill scenarios based on their creation date. </p>" + "documentation":"<p> Filter bill scenarios based on the creation date. </p>" }, "expiresAtFilter":{ "shape":"FilterTimestamp", - "documentation":"<p> Filter bill scenarios based on their expiration date. </p>" + "documentation":"<p> Filter bill scenarios based on the expiration date. </p>" }, "nextToken":{ "shape":"NextPageToken", @@ -3232,11 +3237,11 @@ "members":{ "createdAtFilter":{ "shape":"FilterTimestamp", - "documentation":"<p> Filter workload estimates based on their creation date. </p>" + "documentation":"<p> Filter workload estimates based on the creation date. </p>" }, "expiresAtFilter":{ "shape":"FilterTimestamp", - "documentation":"<p> Filter workload estimates based on their expiration date. </p>" + "documentation":"<p> Filter workload estimates based on the expiration date. </p>" }, "filters":{ "shape":"ListWorkloadEstimatesFilters", diff --git a/contrib/python/botocore/py3/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json b/contrib/python/botocore/py3/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json index 36c06b21b65..61faf9e25b3 100644 --- a/contrib/python/botocore/py3/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/bedrock-agent-runtime/2023-07-26/service-2.json @@ -102,7 +102,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<note> <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeAgent</code>.</p> </note> <p>Sends a prompt for the agent to process and respond to. Note the following fields for the request:</p> <ul> <li> <p>To continue the same conversation with an agent, use the same <code>sessionId</code> value in the request.</p> </li> <li> <p>To activate trace enablement, turn <code>enableTrace</code> to <code>true</code>. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events\">Trace enablement</a>.</p> </li> <li> <p>To stream agent responses, make sure that only orchestration prompt is enabled. Agent streaming is not supported for the following steps: </p> <ul> <li> <p> <code>Pre-processing</code> </p> </li> <li> <p> <code>Post-processing</code> </p> </li> <li> <p>Agent with 1 Knowledge base and <code>User Input</code> not enabled</p> </li> </ul> </li> <li> <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p> </li> <li> <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.</p> </li> </ul> <p>The response is returned in the <code>bytes</code> field of the <code>chunk</code> object.</p> <ul> <li> <p>The <code>attribution</code> object contains citations for parts of the response.</p> </li> <li> <p>If you set <code>enableTrace</code> to <code>true</code> in the request, you can trace the agent's steps and reasoning process that led it to the response.</p> </li> <li> <p>If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the <code>returnControl</code> field.</p> </li> <li> <p>Errors are also surfaced in the response.</p> </li> </ul>" + "documentation":"<note> </note> <p>Sends a prompt for the agent to process and respond to. Note the following fields for the request:</p> <ul> <li> <p>To continue the same conversation with an agent, use the same <code>sessionId</code> value in the request.</p> </li> <li> <p>To activate trace enablement, turn <code>enableTrace</code> to <code>true</code>. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events\">Trace enablement</a>.</p> </li> <li> <p>To stream agent responses, make sure that only orchestration prompt is enabled. Agent streaming is not supported for the following steps: </p> <ul> <li> <p> <code>Pre-processing</code> </p> </li> <li> <p> <code>Post-processing</code> </p> </li> <li> <p>Agent with 1 Knowledge base and <code>User Input</code> not enabled</p> </li> </ul> </li> <li> <p>End a conversation by setting <code>endSession</code> to <code>true</code>.</p> </li> <li> <p>In the <code>sessionState</code> object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.</p> </li> </ul> <p>The response contains both <b>chunk</b> and <b>trace</b> attributes.</p> <p>The final response is returned in the <code>bytes</code> field of the <code>chunk</code> object. The <code>InvokeAgent</code> returns one chunk for the entire interaction.</p> <ul> <li> <p>The <code>attribution</code> object contains citations for parts of the response.</p> </li> <li> <p>If you set <code>enableTrace</code> to <code>true</code> in the request, you can trace the agent's steps and reasoning process that led it to the response.</p> </li> <li> <p>If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the <code>returnControl</code> field.</p> </li> <li> <p>Errors are also surfaced in the response.</p> </li> </ul>" }, "InvokeFlow":{ "name":"InvokeFlow", @@ -146,7 +146,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p> Invokes an inline Amazon Bedrock agent using the configurations you provide with the request. </p> <ul> <li> <p>Specify the following fields for security purposes.</p> <ul> <li> <p>(Optional) <code>customerEncryptionKeyArn</code> – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.</p> </li> <li> <p>(Optional) <code>idleSessionTTLinSeconds</code> – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent <code>InvokeInlineAgent</code> request begins a new session.</p> </li> </ul> </li> <li> <p>To override the default prompt behavior for agent orchestration and to use advanced prompts, include a <code>promptOverrideConfiguration</code> object. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html\">Advanced prompts</a>.</p> </li> <li> <p>The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.</p> </li> </ul> <note> <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeInlineAgent</code>.</p> </note>" + "documentation":"<p> Invokes an inline Amazon Bedrock agent using the configurations you provide with the request. </p> <ul> <li> <p>Specify the following fields for security purposes.</p> <ul> <li> <p>(Optional) <code>customerEncryptionKeyArn</code> – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.</p> </li> <li> <p>(Optional) <code>idleSessionTTLinSeconds</code> – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent <code>InvokeInlineAgent</code> request begins a new session.</p> </li> </ul> </li> <li> <p>To override the default prompt behavior for agent orchestration and to use advanced prompts, include a <code>promptOverrideConfiguration</code> object. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html\">Advanced prompts</a>.</p> </li> <li> <p>The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.</p> </li> </ul> <note> </note>" }, "OptimizePrompt":{ "name":"OptimizePrompt", @@ -253,7 +253,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.</p> <note> <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeModelWithResponseStream</code>.</p> </note>" + "documentation":"<p>Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.</p> <note> <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeModelWithResponseStream</code>.</p> </note> <p>This operation requires permission for the <code> bedrock:RetrieveAndGenerate</code> action.</p>" } }, "shapes":{ @@ -840,7 +840,17 @@ "members":{ "citation":{ "shape":"Citation", - "documentation":"<p>The citation.</p>" + "documentation":"<p>The citation.</p>", + "deprecated":true, + "deprecatedMessage":"Citation is deprecated. Please use GeneratedResponsePart and RetrievedReferences for citation event." + }, + "generatedResponsePart":{ + "shape":"GeneratedResponsePart", + "documentation":"<p>The generated response to the citation event.</p>" + }, + "retrievedReferences":{ + "shape":"RetrievedReferences", + "documentation":"<p>The retrieved references of the citation event.</p>" } }, "documentation":"<p>A citation event.</p>", @@ -1314,7 +1324,16 @@ }, "FlowCompletionReason":{ "type":"string", - "enum":["SUCCESS"] + "enum":[ + "SUCCESS", + "INPUT_REQUIRED" + ] + }, + "FlowExecutionId":{ + "type":"string", + "max":100, + "min":2, + "pattern":"^[0-9a-zA-Z._:-]+$" }, "FlowIdentifier":{ "type":"string", @@ -1326,14 +1345,17 @@ "type":"structure", "required":[ "content", - "nodeName", - "nodeOutputName" + "nodeName" ], "members":{ "content":{ "shape":"FlowInputContent", "documentation":"<p>Contains information about an input into the prompt flow.</p>" }, + "nodeInputName":{ + "shape":"NodeInputName", + "documentation":"<p>The name of the input from the flow input node.</p>" + }, "nodeName":{ "shape":"NodeName", "documentation":"<p>The name of the flow input node that begins the prompt flow.</p>" @@ -1363,6 +1385,42 @@ "max":1, "min":1 }, + "FlowMultiTurnInputContent":{ + "type":"structure", + "members":{ + "document":{ + "shape":"Document", + "documentation":"<p>The requested additional input to send back to the multi-turn flow node.</p>" + } + }, + "documentation":"<p>The content structure containing input information for multi-turn flow interactions.</p>", + "union":true + }, + "FlowMultiTurnInputRequestEvent":{ + "type":"structure", + "required":[ + "content", + "nodeName", + "nodeType" + ], + "members":{ + "content":{ + "shape":"FlowMultiTurnInputContent", + "documentation":"<p>The content payload containing the input request details for the multi-turn interaction.</p>" + }, + "nodeName":{ + "shape":"NodeName", + "documentation":"<p>The name of the node in the flow that is requesting the input.</p>" + }, + "nodeType":{ + "shape":"NodeType", + "documentation":"<p>The type of the node in the flow that is requesting the input.</p>" + } + }, + "documentation":"<p>Response object from the flow multi-turn node requesting additional information.</p>", + "event":true, + "sensitive":true + }, "FlowOutputContent":{ "type":"structure", "members":{ @@ -1422,6 +1480,10 @@ "shape":"FlowCompletionEvent", "documentation":"<p>Contains information about why the flow completed.</p>" }, + "flowMultiTurnInputRequestEvent":{ + "shape":"FlowMultiTurnInputRequestEvent", + "documentation":"<p>The event stream containing the multi-turn input request information from the flow.</p>" + }, "flowOutputEvent":{ "shape":"FlowOutputEvent", "documentation":"<p>Contains information about an output from flow invocation.</p>" @@ -2614,7 +2676,11 @@ "InternalServerException":{ "type":"structure", "members":{ - "message":{"shape":"NonBlankString"} + "message":{"shape":"NonBlankString"}, + "reason":{ + "shape":"String", + "documentation":"<p>The reason for the exception. If the reason is <code>BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE</code>, the model invocation service is unavailable. Retry your request.</p>" + } }, "documentation":"<p>An internal server error occurred. Retry your request.</p>", "error":{"httpStatusCode":500}, @@ -2805,6 +2871,10 @@ "shape":"Boolean", "documentation":"<p>Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html\">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>" }, + "executionId":{ + "shape":"FlowExecutionId", + "documentation":"<p>The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you. </p>" + }, "flowAliasIdentifier":{ "shape":"FlowAliasIdentifier", "documentation":"<p>The unique identifier of the flow alias.</p>", @@ -2831,6 +2901,12 @@ "type":"structure", "required":["responseStream"], "members":{ + "executionId":{ + "shape":"FlowExecutionId", + "documentation":"<p>The unique identifier for the current flow execution.</p>", + "location":"header", + "locationName":"x-amz-bedrock-flow-execution-id" + }, "responseStream":{ "shape":"FlowResponseStream", "documentation":"<p>The output of the flow, returned as a stream. If there's an error, the error is returned.</p>" @@ -2903,6 +2979,10 @@ "documentation":"<p> The unique identifier of the session. Use the same value across requests to continue the same conversation. </p>", "location":"uri", "locationName":"sessionId" + }, + "streamingConfigurations":{ + "shape":"StreamingConfigurations", + "documentation":"<p> Specifies the configurations for streaming. </p> <note> <p>To use agent streaming, you need permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action.</p> </note>" } } }, @@ -3884,6 +3964,10 @@ "PromptConfiguration":{ "type":"structure", "members":{ + "additionalModelRequestFields":{ + "shape":"Document", + "documentation":"<p>If the Converse or ConverseStream operations support the model, <code>additionalModelRequestFields</code> contains additional inference parameters, beyond the base set of inference parameters in the <code>inferenceConfiguration</code> field. </p> <p>For more information, see <i>Inference request parameters and response fields for foundation models</i> in the Amazon Bedrock user guide.</p>" + }, "basePromptTemplate":{ "shape":"BasePromptTemplate", "documentation":"<p>Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html\">Prompt template placeholder variables</a>. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html\">Configure the prompt templates</a>.</p>" diff --git a/contrib/python/botocore/py3/botocore/data/bedrock-agent/2023-06-05/service-2.json b/contrib/python/botocore/py3/botocore/data/bedrock-agent/2023-06-05/service-2.json index fa107997692..2ff530025dd 100644 --- a/contrib/python/botocore/py3/botocore/data/bedrock-agent/2023-06-05/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/bedrock-agent/2023-06-05/service-2.json @@ -458,7 +458,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html\">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide.</p>", + "documentation":"<p>Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-direct-ingestion.html\">Ingest changes directly into a knowledge base</a> in the Amazon Bedrock User Guide.</p>", "idempotent":true }, "DeletePrompt":{ @@ -754,7 +754,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html\">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide.</p>" + "documentation":"<p>Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-direct-ingestion.html\">Ingest changes directly into a knowledge base</a> in the Amazon Bedrock User Guide.</p>" }, "GetPrompt":{ "name":"GetPrompt", @@ -791,7 +791,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Ingests documents directly into the knowledge base that is connected to the data source. The <code>dataSourceType</code> specified in the content for each document must match the type of the data source that you specify in the header. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html\">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide.</p>", + "documentation":"<p>Ingests documents directly into the knowledge base that is connected to the data source. The <code>dataSourceType</code> specified in the content for each document must match the type of the data source that you specify in the header. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-direct-ingestion.html\">Ingest changes directly into a knowledge base</a> in the Amazon Bedrock User Guide.</p>", "idempotent":true }, "ListAgentActionGroups":{ @@ -1007,7 +1007,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html\">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide.</p>" + "documentation":"<p>Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/kb-direct-ingestion.html\">Ingest changes directly into a knowledge base</a> in the Amazon Bedrock User Guide.</p>" }, "ListKnowledgeBases":{ "name":"ListKnowledgeBases", @@ -1708,7 +1708,7 @@ }, "agentAliasStatus":{ "shape":"AgentAliasStatus", - "documentation":"<p>The status of the alias of the agent and whether it is ready for use. The following statuses are possible:</p> <ul> <li> <p>CREATING – The agent alias is being created.</p> </li> <li> <p>PREPARED – The agent alias is finished being created or updated and is ready to be invoked.</p> </li> <li> <p>FAILED – The agent alias API operation failed.</p> </li> <li> <p>UPDATING – The agent alias is being updated.</p> </li> <li> <p>DELETING – The agent alias is being deleted.</p> </li> </ul>" + "documentation":"<p>The status of the alias of the agent and whether it is ready for use. The following statuses are possible:</p> <ul> <li> <p>CREATING – The agent alias is being created.</p> </li> <li> <p>PREPARED – The agent alias is finished being created or updated and is ready to be invoked.</p> </li> <li> <p>FAILED – The agent alias API operation failed.</p> </li> <li> <p>UPDATING – The agent alias is being updated.</p> </li> <li> <p>DELETING – The agent alias is being deleted.</p> </li> <li> <p>DISSOCIATED - The agent alias has no version associated with it.</p> </li> </ul>" }, "agentId":{ "shape":"Id", @@ -1804,7 +1804,8 @@ "PREPARED", "FAILED", "UPDATING", - "DELETING" + "DELETING", + "DISSOCIATED" ] }, "AgentAliasSummaries":{ @@ -2451,7 +2452,7 @@ "members":{ "modelArn":{ "shape":"BedrockModelArn", - "documentation":"<p>The ARN of the foundation model or <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html\">inference profile</a> to use for parsing.</p>" + "documentation":"<p>The ARN of the foundation model to use for parsing.</p>" }, "parsingModality":{ "shape":"ParsingModality", @@ -2462,7 +2463,7 @@ "documentation":"<p>Instructions for interpreting the contents of a document.</p>" } }, - "documentation":"<p>Settings for a foundation model or <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html\">inference profile</a> used to parse documents for a data source.</p>" + "documentation":"<p>Settings for a foundation model used to parse documents for a data source.</p>" }, "BedrockModelArn":{ "type":"string", @@ -2508,6 +2509,21 @@ "type":"string", "pattern":"[a-z]{1,20}/.{1,20}" }, + "CachePointBlock":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"CachePointType", + "documentation":"<p>Indicates that the CachePointBlock is of the default type</p>" + } + }, + "documentation":"<p>Indicates where a cache checkpoint is located. All information before this checkpoint is cached to be accessed on subsequent requests.</p>" + }, + "CachePointType":{ + "type":"string", + "enum":["default"] + }, "ChatPromptTemplateConfiguration":{ "type":"structure", "required":["messages"], @@ -2678,6 +2694,10 @@ "ContentBlock":{ "type":"structure", "members":{ + "cachePoint":{ + "shape":"CachePointBlock", + "documentation":"<p>Creates a cache checkpoint within a message.</p>" + }, "text":{ "shape":"String", "documentation":"<p>The text in the message.</p>" @@ -4910,7 +4930,7 @@ "FlowNodes":{ "type":"list", "member":{"shape":"FlowNode"}, - "max":20, + "max":40, "min":0 }, "FlowStatus":{ @@ -5092,6 +5112,14 @@ "shape":"UnknownConnectionTargetInputFlowValidationDetails", "documentation":"<p>Details about an unknown target input for a connection.</p>" }, + "unknownNodeInput":{ + "shape":"UnknownNodeInputFlowValidationDetails", + "documentation":"<p>Details about an unknown input for a node.</p>" + }, + "unknownNodeOutput":{ + "shape":"UnknownNodeOutputFlowValidationDetails", + "documentation":"<p>Details about an unknown output for a node.</p>" + }, "unreachableNode":{ "shape":"UnreachableNodeFlowValidationDetails", "documentation":"<p>Details about an unreachable node in the flow.</p>" @@ -5142,7 +5170,9 @@ "MultipleNodeInputConnections", "UnfulfilledNodeInput", "UnsatisfiedConnectionConditions", - "Unspecified" + "Unspecified", + "UnknownNodeInput", + "UnknownNodeOutput" ] }, "FlowValidations":{ @@ -7227,7 +7257,7 @@ "MaximumLength":{ "type":"integer", "box":true, - "max":4096, + "max":8192, "min":0 }, "MemoryConfiguration":{ @@ -7969,6 +7999,10 @@ "PromptConfiguration":{ "type":"structure", "members":{ + "additionalModelRequestFields":{ + "shape":"Document", + "documentation":"<p>If the Converse or ConverseStream operations support the model, <code>additionalModelRequestFields</code> contains additional inference parameters, beyond the base set of inference parameters in the <code>inferenceConfiguration</code> field. </p> <p>For more information, see <i>Inference request parameters and response fields for foundation models</i> in the Amazon Bedrock user guide.</p>" + }, "basePromptTemplate":{ "shape":"BasePromptTemplate", "documentation":"<p>Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html\">Prompt template placeholder variables</a>. For more information, see <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html\">Configure the prompt templates</a>.</p>" @@ -8131,7 +8165,7 @@ "PromptInputVariablesList":{ "type":"list", "member":{"shape":"PromptInputVariable"}, - "max":5, + "max":10, "min":0, "sensitive":true }, @@ -9451,6 +9485,10 @@ "SystemContentBlock":{ "type":"structure", "members":{ + "cachePoint":{ + "shape":"CachePointBlock", + "documentation":"<p>Creates a cache checkpoint within a tool designation</p>" + }, "text":{ "shape":"NonEmptyString", "documentation":"<p>The text in the system prompt.</p>" @@ -9544,6 +9582,10 @@ "type":"structure", "required":["text"], "members":{ + "cachePoint":{ + "shape":"CachePointBlock", + "documentation":"<p>A cache checkpoint within a template configuration.</p>" + }, "inputVariables":{ "shape":"PromptInputVariablesList", "documentation":"<p>An array of the variables in the prompt template.</p>" @@ -9571,6 +9613,10 @@ "Tool":{ "type":"structure", "members":{ + "cachePoint":{ + "shape":"CachePointBlock", + "documentation":"<p>Creates a cache checkpoint within a tool designation</p>" + }, "toolSpec":{ "shape":"ToolSpecification", "documentation":"<p>The specification for the tool.</p>" @@ -9800,6 +9846,42 @@ }, "documentation":"<p>Details about an unknown target input for a connection.</p>" }, + "UnknownNodeInputFlowValidationDetails":{ + "type":"structure", + "required":[ + "input", + "node" + ], + "members":{ + "input":{ + "shape":"FlowNodeInputName", + "documentation":"<p>The name of the node with the unknown input.</p>" + }, + "node":{ + "shape":"FlowNodeName", + "documentation":"<p>The name of the unknown input.</p>" + } + }, + "documentation":"<p>Details about an unknown input for a node.</p>" + }, + "UnknownNodeOutputFlowValidationDetails":{ + "type":"structure", + "required":[ + "node", + "output" + ], + "members":{ + "node":{ + "shape":"FlowNodeName", + "documentation":"<p>The name of the node with the unknown output.</p>" + }, + "output":{ + "shape":"FlowNodeOutputName", + "documentation":"<p>The name of the unknown output.</p>" + } + }, + "documentation":"<p>Details about an unknown output for a node.</p>" + }, "UnreachableNodeFlowValidationDetails":{ "type":"structure", "required":["node"], @@ -10535,6 +10617,12 @@ "min":15, "sensitive":true }, + "UserAgentHeader":{ + "type":"string", + "max":86, + "min":61, + "sensitive":true + }, "ValidateFlowDefinitionRequest":{ "type":"structure", "required":["definition"], @@ -10617,7 +10705,7 @@ "members":{ "embeddingModelArn":{ "shape":"BedrockEmbeddingModelArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the model or inference profile used to create vector embeddings for the knowledge base.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.</p>" }, "embeddingModelConfiguration":{ "shape":"EmbeddingModelConfiguration", @@ -10657,7 +10745,11 @@ }, "userAgent":{ "shape":"UserAgent", - "documentation":"<p>A string used for identifying the crawler or a bot when it accesses a web server. By default, this is set to <code>bedrockbot_UUID</code> for your crawler. You can optionally append a custom string to <code>bedrockbot_UUID</code> to allowlist a specific user agent permitted to access your source URLs. </p>" + "documentation":"<p>Returns the user agent suffix for your web crawler.</p>" + }, + "userAgentHeader":{ + "shape":"UserAgentHeader", + "documentation":"<p>A string used for identifying the crawler or bot when it accesses a web server. The user agent header value consists of the <code>bedrockbot</code>, UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to <code>bedrockbot_UUID</code>. You can optionally append a custom suffix to <code>bedrockbot_UUID</code> to allowlist a specific user agent permitted to access your source URLs. </p>" } }, "documentation":"<p>The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.</p>" diff --git a/contrib/python/botocore/py3/botocore/data/bedrock-runtime/2023-09-30/service-2.json b/contrib/python/botocore/py3/botocore/data/bedrock-runtime/2023-09-30/service-2.json index 677a523eb41..dc5ad400a49 100644 --- a/contrib/python/botocore/py3/botocore/data/bedrock-runtime/2023-09-30/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/bedrock-runtime/2023-09-30/service-2.json @@ -2744,7 +2744,7 @@ "type":"string", "max":64, "min":1, - "pattern":"[a-zA-Z][a-zA-Z0-9_]*" + "pattern":"[a-zA-Z0-9_-]+" }, "ToolResultBlock":{ "type":"structure", diff --git a/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/paginators-1.json b/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/paginators-1.json index 7ded8632539..f7aa541b851 100644 --- a/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/paginators-1.json @@ -119,6 +119,18 @@ "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "ResourceScanSummaries" + }, + "ListStackRefactorActions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "StackRefactorActions" + }, + "ListStackRefactors": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "StackRefactorSummaries" } } } diff --git a/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/service-2.json b/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/service-2.json index ae52fef768e..3ee4dd7bd21 100644 --- a/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/service-2.json @@ -169,6 +169,19 @@ ], "documentation":"<p>Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region. You must specify at least one value for either <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for <code>Regions</code>.</p>" }, + "CreateStackRefactor":{ + "name":"CreateStackRefactor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStackRefactorInput"}, + "output":{ + "shape":"CreateStackRefactorOutput", + "resultWrapper":"CreateStackRefactorResult" + }, + "documentation":"<p>Creates a refactor across multiple stacks, with the list of stacks and resources that are affected.</p>" + }, "CreateStackSet":{ "name":"CreateStackSet", "http":{ @@ -472,6 +485,22 @@ ], "documentation":"<p>Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and Amazon Web Services Region.</p> <p>For a list of stack instances that are associated with a specific StackSet, use <a>ListStackInstances</a>.</p>" }, + "DescribeStackRefactor":{ + "name":"DescribeStackRefactor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackRefactorInput"}, + "output":{ + "shape":"DescribeStackRefactorOutput", + "resultWrapper":"DescribeStackRefactorResult" + }, + "errors":[ + {"shape":"StackRefactorNotFoundException"} + ], + "documentation":"<p>Describes the stack refactor status.</p>" + }, "DescribeStackResource":{ "name":"DescribeStackResource", "http":{ @@ -634,7 +663,7 @@ {"shape":"OperationInProgressException"}, {"shape":"StackSetNotFoundException"} ], - "documentation":"<p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">How CloudFormation performs drift detection on a stack set</a>.</p> <p> <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set drift detection operation. Use this operation id with <a>DescribeStackSetOperation</a> to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.</p> <p>Once the operation has completed, use the following actions to return drift information:</p> <ul> <li> <p>Use <a>DescribeStackSet</a> to return detailed information about the stack set, including detailed information about the last <i>completed</i> drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)</p> </li> <li> <p>Use <a>ListStackInstances</a> to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.</p> </li> <li> <p>Use <a>DescribeStackInstance</a> to return detailed information about a specific stack instance, including its drift status and last drift time checked.</p> </li> </ul> <p>For more information about performing a drift detection operation on a stack set, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">Detecting unmanaged changes in stack sets</a>.</p> <p>You can only run a single drift detection operation on a given stack set at one time.</p> <p>To stop a drift detection stack set operation, use <a>StopStackSetOperation</a>.</p>" + "documentation":"<p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">Performing drift detection on CloudFormation StackSets</a>.</p> <p> <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set drift detection operation. Use this operation id with <a>DescribeStackSetOperation</a> to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, in addition to the number of resources included in each stack.</p> <p>Once the operation has completed, use the following actions to return drift information:</p> <ul> <li> <p>Use <a>DescribeStackSet</a> to return detailed information about the stack set, including detailed information about the last <i>completed</i> drift operation performed on the stack set. (Information about drift operations that are in progress isn't included.)</p> </li> <li> <p>Use <a>ListStackInstances</a> to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.</p> </li> <li> <p>Use <a>DescribeStackInstance</a> to return detailed information about a specific stack instance, including its drift status and last drift time checked.</p> </li> </ul> <p>You can only run a single drift detection operation on a given stack set at one time.</p> <p>To stop a drift detection stack set operation, use <a>StopStackSetOperation</a>.</p>" }, "EstimateTemplateCost":{ "name":"EstimateTemplateCost", @@ -668,6 +697,15 @@ ], "documentation":"<p>Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the <a>DescribeStacks</a> action to view the status of the update.</p> <p>When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.</p> <p>If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.</p> <p>To create a change set for the entire stack hierarchy, <code>IncludeNestedStacks</code> must have been set to <code>True</code>.</p>" }, + "ExecuteStackRefactor":{ + "name":"ExecuteStackRefactor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExecuteStackRefactorInput"}, + "documentation":"<p>Executes the stack refactor operation.</p>" + }, "GetGeneratedTemplate":{ "name":"GetGeneratedTemplate", "http":{ @@ -900,6 +938,32 @@ ], "documentation":"<p>Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.</p>" }, + "ListStackRefactorActions":{ + "name":"ListStackRefactorActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStackRefactorActionsInput"}, + "output":{ + "shape":"ListStackRefactorActionsOutput", + "resultWrapper":"ListStackRefactorActionsResult" + }, + "documentation":"<p>Lists the stack refactor actions that will be taken after calling the <a>ExecuteStackRefactor</a> action.</p>" + }, + "ListStackRefactors":{ + "name":"ListStackRefactors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStackRefactorsInput"}, + "output":{ + "shape":"ListStackRefactorsOutput", + "resultWrapper":"ListStackRefactorsResult" + }, + "documentation":"<p>Lists all account stack refactor operations and their statuses.</p>" + }, "ListStackResources":{ "name":"ListStackResources", "http":{ @@ -1362,7 +1426,7 @@ "documentation":"<p>The reason for the account gate status assigned to this account and Region for the stack set operation.</p>" } }, - "documentation":"<p>Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a stack set operation in an account and Region.</p> <p>For each account and Region, CloudFormation lets you specify a Lambda function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and Region. CloudFormation invokes the function each time a stack set operation is requested for that account and Region; if the function returns <code>FAILED</code>, CloudFormation cancels the operation in that account and Region, and sets the stack set operation result status for that account and Region to <code>FAILED</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html\">Configuring a target account gate</a>.</p>" + "documentation":"<p>Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a stack set operation in an account and Region.</p> <p>For each account and Region, CloudFormation lets you specify a Lambda function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and Region. CloudFormation invokes the function each time a stack set operation is requested for that account and Region; if the function returns <code>FAILED</code>, CloudFormation cancels the operation in that account and Region, and sets the stack set operation result status for that account and Region to <code>FAILED</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html\">Configuring a target account gate in StackSets</a> in the <i>CloudFormation User Guide</i>.</p>" }, "AccountGateStatus":{ "type":"string", @@ -1640,7 +1704,7 @@ }, "HookInvocationCount":{ "shape":"HookInvocationCount", - "documentation":"<p>Is either <code>null</code>, if no hooks invoke for the resource, or contains the number of hooks that will invoke for the resource.</p>" + "documentation":"<p>Is either <code>null</code>, if no Hooks invoke for the resource, or contains the number of Hooks that will invoke for the resource.</p>" }, "ResourceChange":{ "shape":"ResourceChange", @@ -1705,7 +1769,7 @@ "documentation":"<p>Specifies the action of the resource.</p>" } }, - "documentation":"<p>Specifies <code>RESOURCE</code> type target details for activated hooks.</p>" + "documentation":"<p>Specifies <code>RESOURCE</code> type target details for activated Hooks.</p>" }, "ChangeSetHookTargetDetails":{ "type":"structure", @@ -1805,7 +1869,7 @@ }, "Status":{ "shape":"ChangeSetStatus", - "documentation":"<p>The state of the change set, such as <code>CREATE_IN_PROGRESS</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>" + "documentation":"<p>The state of the change set, such as <code>CREATE_PENDING</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>" }, "StatusReason":{ "shape":"ChangeSetStatusReason", @@ -1952,7 +2016,7 @@ }, "TemplateURL":{ "shape":"TemplateURL", - "documentation":"<p>The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>" + "documentation":"<p>The URL of the file that contains the revised template. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>" }, "UsePreviousTemplate":{ "shape":"UsePreviousTemplate", @@ -1964,11 +2028,11 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html\"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html\"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html\"> AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html\"> AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html\">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p> <note> <p>This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.</p> <p>If you want to create a stack from a stack template that contains macros <i>and</i> nested stacks, you must create or update the stack directly from the template using the <a>CreateStack</a> or <a>UpdateStack</a> action, and specifying this capability.</p> </note> <p>For more information about macros, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Perform custom processing on CloudFormation templates with template macros</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" + "documentation":"<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html\"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html\"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html\"> AWS::IAM::ManagedPolicy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html\"> AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html\"> AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html\">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p> <note> <p>This capacity doesn't apply to creating change sets, and specifying it when creating change sets has no effect.</p> <p>If you want to create a stack from a stack template that contains macros <i>and</i> nested stacks, you must create or update the stack directly from the template using the <a>CreateStack</a> or <a>UpdateStack</a> action, and specifying this capability.</p> </note> <p>For more information about macros, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Perform custom processing on CloudFormation templates with template macros</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" }, "ResourceTypes":{ "shape":"ResourceTypes", - "documentation":"<p>The template resource types that you have permissions to work with if you execute this change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Control access with Identity and Access Management</a> in the <i>CloudFormation User Guide</i>.</p> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" + "documentation":"<p>The template resource types that you have permissions to work with if you execute this change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html\">Control access with Identity and Access Management</a> in the <i>CloudFormation User Guide</i>.</p> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" }, "RoleARN":{ "shape":"RoleARN", @@ -2080,7 +2144,7 @@ }, "TemplateURL":{ "shape":"TemplateURL", - "documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>" + "documentation":"<p>The URL of a file containing the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>" }, "Parameters":{ "shape":"Parameters", @@ -2104,11 +2168,11 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html\">AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html\">AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html\">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\">AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html\">AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html\">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p> <p>If you want to create a stack from a stack template that contains macros <i>and</i> nested stacks, you must create the stack directly from the template using this capability.</p> <important> <p>You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.</p> <p>Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.</p> </important> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Perform custom processing on CloudFormation templates with template macros</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" + "documentation":"<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html\">AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html\">AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html\"> AWS::IAM::ManagedPolicy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html\">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\">AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html\">AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html\">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p> <p>If you want to create a stack from a stack template that contains macros <i>and</i> nested stacks, you must create the stack directly from the template using this capability.</p> <important> <p>You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.</p> <p>Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.</p> </important> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Perform custom processing on CloudFormation templates with template macros</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" }, "ResourceTypes":{ "shape":"ResourceTypes", - "documentation":"<p>The template resource types that you have permissions to work with for this create stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. Use the following syntax to describe template resource types: <code>AWS::*</code> (for all Amazon Web Services resources), <code>Custom::*</code> (for all custom resources), <code>Custom::<i>logical_ID</i> </code> (for a specific custom resource), <code>AWS::<i>service_name</i>::*</code> (for all resources of a particular Amazon Web Services service), and <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i> </code> (for a specific Amazon Web Services resource).</p> <p>If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Control access with Identity and Access Management</a>.</p> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" + "documentation":"<p>The template resource types that you have permissions to work with for this create stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. Use the following syntax to describe template resource types: <code>AWS::*</code> (for all Amazon Web Services resources), <code>Custom::*</code> (for all custom resources), <code>Custom::<i>logical_ID</i> </code> (for a specific custom resource), <code>AWS::<i>service_name</i>::*</code> (for all resources of a particular Amazon Web Services service), and <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i> </code> (for a specific Amazon Web Services resource).</p> <p>If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html\">Control access with Identity and Access Management</a>.</p> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" }, "RoleARN":{ "shape":"RoleARN", @@ -2158,7 +2222,7 @@ }, "Accounts":{ "shape":"AccountList", - "documentation":"<p>[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>" + "documentation":"<p>[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts that you want to create stack instances in the specified Region(s) for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>" }, "DeploymentTargets":{ "shape":"DeploymentTargets", @@ -2206,6 +2270,38 @@ }, "documentation":"<p>The output for a <a>CreateStack</a> action.</p>" }, + "CreateStackRefactorInput":{ + "type":"structure", + "required":["StackDefinitions"], + "members":{ + "Description":{ + "shape":"Description", + "documentation":"<p>A description to help you identify the stack refactor.</p>" + }, + "EnableStackCreation":{ + "shape":"EnableStackCreation", + "documentation":"<p>Determines if a new stack is created with the refactor.</p>" + }, + "ResourceMappings":{ + "shape":"ResourceMappings", + "documentation":"<p>The mappings for the stack resource <code>Source</code> and stack resource <code>Destination</code>.</p>" + }, + "StackDefinitions":{ + "shape":"StackDefinitions", + "documentation":"<p>The stacks being refactored.</p>" + } + } + }, + "CreateStackRefactorOutput":{ + "type":"structure", + "required":["StackRefactorId"], + "members":{ + "StackRefactorId":{ + "shape":"StackRefactorId", + "documentation":"<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>" + } + } + }, "CreateStackSetInput":{ "type":"structure", "required":["StackSetName"], @@ -2224,7 +2320,7 @@ }, "TemplateURL":{ "shape":"TemplateURL", - "documentation":"<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document.</p> <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>" + "documentation":"<p>The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>" }, "StackId":{ "shape":"StackId", @@ -2236,7 +2332,7 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"<p>In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html\">AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html\">AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html\">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\">AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html\">AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html\">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Using CloudFormation Macros to Perform Custom Processing on Templates</a>.</p> <important> <p>Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.</p> </important> </li> </ul>" + "documentation":"<p>In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for CloudFormation to create the stack set and related stack instances.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new IAM users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html\">AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html\">AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html\">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\">AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html\">AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html\">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some templates reference macros. If your stack set template references one or more macros, you must create the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To create the stack set directly, you must acknowledge this capability. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Perform custom processing on CloudFormation templates with template macros</a>.</p> <important> <p>Stack sets with service-managed permissions don't currently support the use of macros in templates. (This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.</p> </important> </li> </ul>" }, "Tags":{ "shape":"Tags", @@ -2244,7 +2340,7 @@ }, "AdministrationRoleARN":{ "shape":"RoleARN", - "documentation":"<p>The Amazon Resource Name (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=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Prerequisites: Granting Permissions for Stack Set Operations</a> in the <i>CloudFormation User Guide</i>.</p>" + "documentation":"<p>The Amazon Resource Name (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=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Prerequisites for using StackSets</a> in the <i>CloudFormation User Guide</i>.</p>" }, "ExecutionRoleName":{ "shape":"ExecutionRoleName", @@ -2252,7 +2348,7 @@ }, "PermissionModel":{ "shape":"PermissionModels", - "documentation":"<p>Describes how the IAM roles required for stack set operations are created. By default, <code>SELF-MANAGED</code> is specified.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html\">Grant Self-Managed Stack Set Permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html\">Grant Service-Managed Stack Set Permissions</a>.</p> </li> </ul>" + "documentation":"<p>Describes how the IAM roles required for stack set operations are created. By default, <code>SELF-MANAGED</code> is specified.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html\">Grant self-managed permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html\">Activate trusted access for stack sets with Organizations</a>.</p> </li> </ul>" }, "AutoDeployment":{ "shape":"AutoDeployment", @@ -2399,7 +2495,7 @@ }, "Accounts":{ "shape":"AccountList", - "documentation":"<p>[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>" + "documentation":"<p>[Self-managed permissions] The account IDs of the Amazon Web Services accounts that you want to delete stack instances for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>" }, "DeploymentTargets":{ "shape":"DeploymentTargets", @@ -2469,15 +2565,15 @@ "members":{ "Accounts":{ "shape":"AccountList", - "documentation":"<p>The names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.</p>" + "documentation":"<p>The account IDs of the Amazon Web Services accounts. If you have many account numbers, you can provide those accounts using the <code>AccountsUrl</code> property instead.</p>" }, "AccountsUrl":{ "shape":"AccountsUrl", - "documentation":"<p>Returns the value of the <code>AccountsUrl</code> property.</p>" + "documentation":"<p>The Amazon S3 URL path to a file that contains a list of Amazon Web Services account IDs. The file format must be either <code>.csv</code> or <code>.txt</code>, and the data can be comma-separated or new-line-separated. There is currently a 10MB limit for the data (approximately 800,000 accounts).</p> <p/>" }, "OrganizationalUnitIds":{ "shape":"OrganizationalUnitIdList", - "documentation":"<p>The organization root ID or organizational unit (OU) IDs to which StackSets deploys.</p>" + "documentation":"<p>The organization root ID or organizational unit (OU) IDs.</p>" }, "AccountFilterType":{ "shape":"AccountFilterType", @@ -2561,7 +2657,7 @@ }, "LogicalResourceId":{ "shape":"LogicalResourceId", - "documentation":"<p>If specified, lists only the hooks related to the specified <code>LogicalResourceId</code>.</p>" + "documentation":"<p>If specified, lists only the Hooks related to the specified <code>LogicalResourceId</code>.</p>" } } }, @@ -2658,7 +2754,7 @@ }, "Status":{ "shape":"ChangeSetStatus", - "documentation":"<p>The current status of the change set, such as <code>CREATE_IN_PROGRESS</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>" + "documentation":"<p>The current status of the change set, such as <code>CREATE_PENDING</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>" }, "StatusReason":{ "shape":"ChangeSetStatusReason", @@ -2981,6 +3077,49 @@ } } }, + "DescribeStackRefactorInput":{ + "type":"structure", + "required":["StackRefactorId"], + "members":{ + "StackRefactorId":{ + "shape":"StackRefactorId", + "documentation":"<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>" + } + } + }, + "DescribeStackRefactorOutput":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"Description", + "documentation":"<p>A description to help you identify the refactor.</p>" + }, + "StackRefactorId":{ + "shape":"StackRefactorId", + "documentation":"<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>" + }, + "StackIds":{ + "shape":"StackIds", + "documentation":"<p>The unique ID for each stack.</p>" + }, + "ExecutionStatus":{ + "shape":"StackRefactorExecutionStatus", + "documentation":"<p>The stack refactor execution operation status that's provided after calling the <a>ExecuteStackRefactor</a> action.</p>" + }, + "ExecutionStatusReason":{ + "shape":"ExecutionStatusReason", + "documentation":"<p>A detailed explanation for the stack refactor <code>ExecutionStatus</code>.</p>" + }, + "Status":{ + "shape":"StackRefactorStatus", + "documentation":"<p>The stack refactor operation status that's provided after calling the <a>CreateStackRefactor</a> action.</p>" + }, + "StatusReason":{ + "shape":"StackRefactorStatusReason", + "documentation":"<p>A detailed explanation for the stack refactor operation <code>Status</code>.</p>" + } + } + }, "DescribeStackResourceDriftsInput":{ "type":"structure", "required":["StackName"], @@ -3422,6 +3561,7 @@ } } }, + "DetectionReason":{"type":"string"}, "DifferenceType":{ "type":"string", "enum":[ @@ -3435,6 +3575,7 @@ "type":"integer", "min":0 }, + "EnableStackCreation":{"type":"boolean"}, "EnableTerminationProtection":{"type":"boolean"}, "ErrorCode":{ "type":"string", @@ -3455,7 +3596,7 @@ }, "TemplateURL":{ "shape":"TemplateURL", - "documentation":"<p>Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>" + "documentation":"<p>The URL of a file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>" }, "Parameters":{ "shape":"Parameters", @@ -3515,6 +3656,16 @@ }, "documentation":"<p>The output for the <a>ExecuteChangeSet</a> action.</p>" }, + "ExecuteStackRefactorInput":{ + "type":"structure", + "required":["StackRefactorId"], + "members":{ + "StackRefactorId":{ + "shape":"StackRefactorId", + "documentation":"<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>" + } + } + }, "ExecutionRoleName":{ "type":"string", "max":64, @@ -3532,6 +3683,7 @@ "OBSOLETE" ] }, + "ExecutionStatusReason":{"type":"string"}, "Export":{ "type":"structure", "members":{ @@ -3716,7 +3868,7 @@ }, "TemplateURL":{ "shape":"TemplateURL", - "documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>" + "documentation":"<p>The URL of a file containing the template body. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>" }, "StackName":{ "shape":"StackNameOrId", @@ -3750,7 +3902,7 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"<p>The capabilities found within the template. If your template contains IAM resources, you must specify the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p>" + "documentation":"<p>The capabilities found within the template. If your template contains IAM resources, you must specify the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p>" }, "CapabilitiesReason":{ "shape":"CapabilitiesReason", @@ -4441,6 +4593,69 @@ } } }, + "ListStackRefactorActionsInput":{ + "type":"structure", + "required":["StackRefactorId"], + "members":{ + "StackRefactorId":{ + "shape":"StackRefactorId", + "documentation":"<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"<p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>" + } + } + }, + "ListStackRefactorActionsOutput":{ + "type":"structure", + "required":["StackRefactorActions"], + "members":{ + "StackRefactorActions":{ + "shape":"StackRefactorActions", + "documentation":"<p>The stack refactor actions.</p>" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"<p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>" + } + } + }, + "ListStackRefactorsInput":{ + "type":"structure", + "members":{ + "ExecutionStatusFilter":{ + "shape":"StackRefactorExecutionStatusFilter", + "documentation":"<p>Execution status to use as a filter. Specify one or more execution status codes to list only stack refactors with the specified execution status codes.</p>" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"<p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>" + } + } + }, + "ListStackRefactorsOutput":{ + "type":"structure", + "required":["StackRefactorSummaries"], + "members":{ + "StackRefactorSummaries":{ + "shape":"StackRefactorSummaries", + "documentation":"<p>Provides a summary of a stack refactor, including the following:</p> <ul> <li> <p> <code>StackRefactorId</code> </p> </li> <li> <p> <code>Status</code> </p> </li> <li> <p> <code>StatusReason</code> </p> </li> <li> <p> <code>ExecutionStatus</code> </p> </li> <li> <p> <code>ExecutionStatusReason</code> </p> </li> <li> <p> <code>Description</code> </p> </li> </ul>" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"<p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>" + } + } + }, "ListStackResourcesInput":{ "type":"structure", "required":["StackName"], @@ -5060,7 +5275,7 @@ }, "ResolvedValue":{ "shape":"ParameterValue", - "documentation":"<p>Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems Manager parameter types in the template. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-supplied-parameter-types.html\">Use CloudFormation-supplied parameter types</a> in the <i>CloudFormation User Guide</i>.</p>" + "documentation":"<p>Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems Manager parameter types in the template. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-supplied-parameter-types.html\">Specify existing resources at runtime with CloudFormation-supplied parameter types</a> in the <i>CloudFormation User Guide</i>.</p>" } }, "documentation":"<p>The Parameter data type.</p>" @@ -5362,7 +5577,7 @@ }, "TypeName":{ "shape":"TypeName", - "documentation":"<p>The name of the extension being registered.</p> <p>We suggest that extension names adhere to the following patterns:</p> <ul> <li> <p>For resource types, <code>company_or_organization::service::type</code>.</p> </li> <li> <p>For modules, <code>company_or_organization::service::type::MODULE</code>.</p> </li> <li> <p>For hooks, <code>MyCompany::Testing::MyTestHook</code>.</p> </li> </ul> <note> <p>The following organization namespaces are reserved and can't be used in your extension names:</p> <ul> <li> <p> <code>Alexa</code> </p> </li> <li> <p> <code>AMZN</code> </p> </li> <li> <p> <code>Amazon</code> </p> </li> <li> <p> <code>AWS</code> </p> </li> <li> <p> <code>Custom</code> </p> </li> <li> <p> <code>Dev</code> </p> </li> </ul> </note>" + "documentation":"<p>The name of the extension being registered.</p> <p>We suggest that extension names adhere to the following patterns:</p> <ul> <li> <p>For resource types, <code>company_or_organization::service::type</code>.</p> </li> <li> <p>For modules, <code>company_or_organization::service::type::MODULE</code>.</p> </li> <li> <p>For Hooks, <code>MyCompany::Testing::MyTestHook</code>.</p> </li> </ul> <note> <p>The following organization namespaces are reserved and can't be used in your extension names:</p> <ul> <li> <p> <code>Alexa</code> </p> </li> <li> <p> <code>AMZN</code> </p> </li> <li> <p> <code>Amazon</code> </p> </li> <li> <p> <code>AWS</code> </p> </li> <li> <p> <code>Custom</code> </p> </li> <li> <p> <code>Dev</code> </p> </li> </ul> </note>" }, "SchemaHandlerPackage":{ "shape":"S3Url", @@ -5670,6 +5885,46 @@ "type":"list", "member":{"shape":"ResourceIdentifierPropertyKey"} }, + "ResourceLocation":{ + "type":"structure", + "required":[ + "StackName", + "LogicalResourceId" + ], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"<p>The name associated with the stack.</p>" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"<p>The logical name of the resource specified in the template.</p>" + } + }, + "documentation":"<p>The location of the resource in a stack template.</p>" + }, + "ResourceMapping":{ + "type":"structure", + "required":[ + "Source", + "Destination" + ], + "members":{ + "Source":{ + "shape":"ResourceLocation", + "documentation":"<p>The source stack <code>StackName</code> and <code>LogicalResourceId</code> for the resource being refactored.</p>" + }, + "Destination":{ + "shape":"ResourceLocation", + "documentation":"<p>The destination stack <code>StackName</code> and <code>LogicalResourceId</code> for the resource being refactored.</p>" + } + }, + "documentation":"<p>Specifies the current source of the resource and the destination of where it will be moved to.</p>" + }, + "ResourceMappings":{ + "type":"list", + "member":{"shape":"ResourceMapping"} + }, "ResourceModel":{ "type":"string", "max":16384, @@ -5793,6 +6048,12 @@ "IMPORT_ROLLBACK_IN_PROGRESS", "IMPORT_ROLLBACK_FAILED", "IMPORT_ROLLBACK_COMPLETE", + "EXPORT_FAILED", + "EXPORT_COMPLETE", + "EXPORT_IN_PROGRESS", + "EXPORT_ROLLBACK_IN_PROGRESS", + "EXPORT_ROLLBACK_FAILED", + "EXPORT_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_IN_PROGRESS", "UPDATE_ROLLBACK_COMPLETE", "UPDATE_ROLLBACK_FAILED", @@ -6265,6 +6526,28 @@ }, "documentation":"<p>The Stack data type.</p>" }, + "StackDefinition":{ + "type":"structure", + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"<p>The name associated with the stack.</p>" + }, + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"<p>The file path for the stack template file.</p>" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"<p>The desired final state of the stack template.</p>" + } + }, + "documentation":"<p>Describes the stack and the template used by the stack.</p>" + }, + "StackDefinitions":{ + "type":"list", + "member":{"shape":"StackDefinition"} + }, "StackDriftDetectionId":{ "type":"string", "max":36, @@ -6385,7 +6668,7 @@ }, "HookInvocationPoint":{ "shape":"HookInvocationPoint", - "documentation":"<p>Invocation points are points in provisioning logic where hooks are initiated.</p>" + "documentation":"<p>Invocation points are points in provisioning logic where Hooks are initiated.</p>" }, "HookFailureMode":{ "shape":"HookFailureMode", @@ -6407,6 +6690,10 @@ "type":"list", "member":{"shape":"StackId"} }, + "StackIds":{ + "type":"list", + "member":{"shape":"StackId"} + }, "StackIdsUrl":{ "type":"string", "max":5120, @@ -6684,6 +6971,163 @@ "max":1350, "min":1 }, + "StackRefactorAction":{ + "type":"structure", + "members":{ + "Action":{ + "shape":"StackRefactorActionType", + "documentation":"<p>The action that CloudFormation takes on the stack.</p>" + }, + "Entity":{ + "shape":"StackRefactorActionEntity", + "documentation":"<p>The type that will be evaluated in the <code>StackRefactorAction</code>. The following are potential <code>Entity</code> types:</p> <ul> <li> <p> <code>Stack</code> </p> </li> <li> <p> <code>Resource</code> </p> </li> </ul>" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"<p>The name or unique identifier associated with the physical instance of the resource.</p>" + }, + "ResourceIdentifier":{ + "shape":"StackRefactorResourceIdentifier", + "documentation":"<p>A key-value pair that identifies the target resource. The key is an identifier property (for example, <code>BucketName</code> for <code>AWS::S3::Bucket</code> resources) and the value is the actual property value (for example, <code>MyS3Bucket</code>).</p>" + }, + "Description":{ + "shape":"Description", + "documentation":"<p>A description to help you identify the refactor.</p>" + }, + "Detection":{ + "shape":"StackRefactorDetection", + "documentation":"<p>The detection type is one of the following:</p> <ul> <li> <p>Auto: CloudFormation figured out the mapping on its own.</p> </li> <li> <p>Manual: The customer provided the mapping in the <code>ResourceMapping</code> parameter.</p> </li> </ul>" + }, + "DetectionReason":{ + "shape":"DetectionReason", + "documentation":"<p>The description of the detection type.</p>" + }, + "TagResources":{ + "shape":"StackRefactorTagResources", + "documentation":"<p>Assigns one or more tags to specified resources.</p>" + }, + "UntagResources":{ + "shape":"StackRefactorUntagResources", + "documentation":"<p>Removes one or more tags to specified resources.</p>" + }, + "ResourceMapping":{ + "shape":"ResourceMapping", + "documentation":"<p>The mapping for the stack resource <code>Source</code> and stack resource <code>Destination</code>.</p>" + } + }, + "documentation":"<p>Describes the stack and the action that CloudFormation will perform on it if you execute the stack refactor.</p>" + }, + "StackRefactorActionEntity":{ + "type":"string", + "enum":[ + "RESOURCE", + "STACK" + ] + }, + "StackRefactorActionType":{ + "type":"string", + "enum":[ + "MOVE", + "CREATE" + ] + }, + "StackRefactorActions":{ + "type":"list", + "member":{"shape":"StackRefactorAction"} + }, + "StackRefactorDetection":{ + "type":"string", + "enum":[ + "AUTO", + "MANUAL" + ] + }, + "StackRefactorExecutionStatus":{ + "type":"string", + "enum":[ + "UNAVAILABLE", + "AVAILABLE", + "OBSOLETE", + "EXECUTE_IN_PROGRESS", + "EXECUTE_COMPLETE", + "EXECUTE_FAILED", + "ROLLBACK_IN_PROGRESS", + "ROLLBACK_COMPLETE", + "ROLLBACK_FAILED" + ] + }, + "StackRefactorExecutionStatusFilter":{ + "type":"list", + "member":{"shape":"StackRefactorExecutionStatus"} + }, + "StackRefactorId":{"type":"string"}, + "StackRefactorNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"<p>The specified stack refactor can't be found.</p>", + "error":{ + "code":"StackRefactorNotFoundException", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "StackRefactorResourceIdentifier":{"type":"string"}, + "StackRefactorStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_COMPLETE", + "CREATE_FAILED", + "DELETE_IN_PROGRESS", + "DELETE_COMPLETE", + "DELETE_FAILED" + ] + }, + "StackRefactorStatusReason":{"type":"string"}, + "StackRefactorSummaries":{ + "type":"list", + "member":{"shape":"StackRefactorSummary"} + }, + "StackRefactorSummary":{ + "type":"structure", + "members":{ + "StackRefactorId":{ + "shape":"StackRefactorId", + "documentation":"<p>The ID associated with the stack refactor created from the <a>CreateStackRefactor</a> action.</p>" + }, + "Description":{ + "shape":"Description", + "documentation":"<p>A description to help you identify the refactor.</p>" + }, + "ExecutionStatus":{ + "shape":"StackRefactorExecutionStatus", + "documentation":"<p>The operation status that's provided after calling the <a>ExecuteStackRefactor</a> action.</p>" + }, + "ExecutionStatusReason":{ + "shape":"ExecutionStatusReason", + "documentation":"<p>A detailed explanation for the stack refactor <code>ExecutionStatus</code>.</p>" + }, + "Status":{ + "shape":"StackRefactorStatus", + "documentation":"<p>The stack refactor operation status that's provided after calling the <a>CreateStackRefactor</a> action.</p>" + }, + "StatusReason":{ + "shape":"StackRefactorStatusReason", + "documentation":"<p>A detailed explanation for the stack refactor <code>Status</code>.</p>" + } + }, + "documentation":"<p>The summary of a stack refactor operation.</p>" + }, + "StackRefactorTagResources":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "StackRefactorUntagResources":{ + "type":"list", + "member":{"shape":"TagKey"} + }, "StackResource":{ "type":"structure", "required":[ @@ -6987,7 +7431,7 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"<p>The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p>" + "documentation":"<p>The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p>" }, "Tags":{ "shape":"Tags", @@ -6999,7 +7443,7 @@ }, "AdministrationRoleARN":{ "shape":"RoleARN", - "documentation":"<p>The Amazon Resource Name (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=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Prerequisites: Granting Permissions for Stack Set Operations</a> in the <i>CloudFormation User Guide</i>.</p>" + "documentation":"<p>The Amazon Resource Name (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=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Prerequisites for using CloudFormation StackSets</a> in the <i>CloudFormation User Guide</i>.</p>" }, "ExecutionRoleName":{ "shape":"ExecutionRoleName", @@ -7015,7 +7459,7 @@ }, "PermissionModel":{ "shape":"PermissionModels", - "documentation":"<p>Describes how the IAM roles required for stack set operations are created.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html\">Grant Self-Managed Stack Set Permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html\">Grant Service-Managed Stack Set Permissions</a>.</p> </li> </ul>" + "documentation":"<p>Describes how the IAM roles required for stack set operations are created.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html\">Grant self-managed permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html\">Activate trusted access for stack sets with Organizations</a>.</p> </li> </ul>" }, "OrganizationalUnitIds":{ "shape":"OrganizationalUnitIdList", @@ -7087,7 +7531,7 @@ "documentation":"<p>The number of stack instances for which the drift detection operation failed.</p>" } }, - "documentation":"<p>Detailed information about the drift status of the stack set.</p> <p>For stack sets, contains information about the last <i>completed</i> drift operation performed on the stack set. Information about drift operations in-progress isn't included.</p> <p>For stack set operations, includes information about drift operations currently being performed on the stack set.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">Detecting unmanaged changes in stack sets</a> in the <i>CloudFormation User Guide</i>.</p>" + "documentation":"<p>Detailed information about the drift status of the stack set.</p> <p>For stack sets, contains information about the last <i>completed</i> drift operation performed on the stack set. Information about drift operations in-progress isn't included.</p> <p>For stack set operations, includes information about drift operations currently being performed on the stack set.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">Performing drift detection on CloudFormation StackSets</a> in the <i>CloudFormation User Guide</i>.</p>" }, "StackSetDriftDetectionStatus":{ "type":"string", @@ -7154,7 +7598,7 @@ }, "Status":{ "shape":"StackSetOperationStatus", - "documentation":"<p>The status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and CloudFormation cancels the operation in any remaining Regions.</p> </li> <li> <p> <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-status-codes\">stack set operation status codes</a> in the <i>CloudFormation User Guide</i>.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has canceled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request.</p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>" + "documentation":"<p>The status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and CloudFormation cancels the operation in any remaining Regions.</p> </li> <li> <p> <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html#stackset-status-codes\">StackSets status codes</a> in the <i>CloudFormation User Guide</i>.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has canceled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request.</p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>" }, "OperationPreferences":{ "shape":"StackSetOperationPreferences", @@ -7166,7 +7610,7 @@ }, "AdministrationRoleARN":{ "shape":"RoleARN", - "documentation":"<p>The Amazon Resource Name (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=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>CloudFormation User Guide</i>.</p>" + "documentation":"<p>The Amazon Resource Name (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=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html\">Grant self-managed permissions</a> in the <i>CloudFormation User Guide</i>.</p>" }, "ExecutionRoleName":{ "shape":"ExecutionRoleName", @@ -7186,7 +7630,7 @@ }, "StackSetDriftDetectionDetails":{ "shape":"StackSetDriftDetectionDetails", - "documentation":"<p>Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.</p> <p>This information will only be present for stack set operations whose <code>Action</code> type is <code>DETECT_DRIFT</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">Detect stack set drift</a> in the <i>CloudFormation User Guide</i>.</p>" + "documentation":"<p>Detailed information about the drift status of the stack set. This includes information about drift operations currently being performed on the stack set.</p> <p>This information will only be present for stack set operations whose <code>Action</code> type is <code>DETECT_DRIFT</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">Performing drift detection on CloudFormation StackSets</a> in the <i>CloudFormation User Guide</i>.</p>" }, "StatusReason":{ "shape":"StackSetOperationStatusReason", @@ -7386,7 +7830,7 @@ }, "PermissionModel":{ "shape":"PermissionModels", - "documentation":"<p>Describes how the IAM roles required for stack set operations are created.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html\">Grant Self-Managed Stack Set Permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html\">Grant Service-Managed Stack Set Permissions</a>.</p> </li> </ul>" + "documentation":"<p>Describes how the IAM roles required for stack set operations are created.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html\">Grant self-managed permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html\">Activate trusted access for stack sets with Organizations</a>.</p> </li> </ul>" }, "DriftStatus":{ "shape":"StackDriftStatus", @@ -8156,7 +8600,7 @@ }, "TemplateURL":{ "shape":"TemplateURL", - "documentation":"<p>Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>" + "documentation":"<p>The URL of a file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>" }, "UsePreviousTemplate":{ "shape":"UsePreviousTemplate", @@ -8176,11 +8620,11 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html\"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html\"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html\">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html\"> AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html\">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p> <p>If you want to update a stack from a stack template that contains macros <i>and</i> nested stacks, you must update the stack directly from the template using this capability.</p> <important> <p>You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.</p> <p>Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.</p> </important> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Perform custom processing on CloudFormation templates with template macros</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" + "documentation":"<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html\"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html\"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-managedpolicy.html\"> AWS::IAM::ManagedPolicy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html\">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html\"> AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html\">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.</p> <p>If you want to update a stack from a stack template that contains macros <i>and</i> nested stacks, you must update the stack directly from the template using this capability.</p> <important> <p>You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.</p> <p>Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without CloudFormation being notified.</p> </important> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Perform custom processing on CloudFormation templates with template macros</a>.</p> </li> </ul> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" }, "ResourceTypes":{ "shape":"ResourceTypes", - "documentation":"<p>The template resource types that you have permissions to work with for this update stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Control access with Identity and Access Management</a>.</p> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" + "documentation":"<p>The template resource types that you have permissions to work with for this update stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. IAM uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html\">Control access with Identity and Access Management</a>.</p> <note> <p>Only one of the <code>Capabilities</code> and <code>ResourceType</code> parameters can be specified.</p> </note>" }, "RoleARN":{ "shape":"RoleARN", @@ -8234,7 +8678,7 @@ }, "Accounts":{ "shape":"AccountList", - "documentation":"<p>[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>" + "documentation":"<p>[Self-managed permissions] The account IDs of one or more Amazon Web Services accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>" }, "DeploymentTargets":{ "shape":"DeploymentTargets", @@ -8300,7 +8744,7 @@ }, "TemplateURL":{ "shape":"TemplateURL", - "documentation":"<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>" + "documentation":"<p>The URL of a file that contains the template body. The URL must point to a template (maximum size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>" }, "UsePreviousTemplate":{ "shape":"UsePreviousTemplate", @@ -8312,7 +8756,7 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html\">AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html\">AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html\">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\">AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html\">AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html\">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Using CloudFormation Macros to Perform Custom Processing on Templates</a>.</p> <important> <p>Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.</p> </important> </li> </ul>" + "documentation":"<p>In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to update the stack set and its associated stack instances.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your Amazon Web Services account, for example, by creating new IAM users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability.</p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>.</p> </li> <li> <p>If you don't specify either of these capabilities, CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-accesskey.html\">AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html\">AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\">AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html\">AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\">AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html\">AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-usertogroupaddition.html\">AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some templates reference macros. If your stack set template references one or more macros, you must update the stack set directly from the processed template, without first reviewing the resulting changes in a change set. To update the stack set directly, you must acknowledge this capability. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Perform custom processing on CloudFormation templates with template macros</a>.</p> <important> <p>Stack sets with service-managed permissions do not currently support the use of macros in templates. (This includes the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-include.html\">AWS::Include</a> and <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a stack set with service-managed permissions, if you reference a macro in your template the stack set operation will fail.</p> </important> </li> </ul>" }, "Tags":{ "shape":"Tags", @@ -8324,7 +8768,7 @@ }, "AdministrationRoleARN":{ "shape":"RoleARN", - "documentation":"<p>The Amazon Resource Name (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=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Granting Permissions for Stack Set Operations</a> in the <i>CloudFormation User Guide</i>.</p> <p>If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.</p>" + "documentation":"<p>The Amazon Resource Name (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=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Prerequisites for using CloudFormation StackSets</a> in the <i>CloudFormation User Guide</i>.</p> <p>If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.</p>" }, "ExecutionRoleName":{ "shape":"ExecutionRoleName", @@ -8336,7 +8780,7 @@ }, "PermissionModel":{ "shape":"PermissionModels", - "documentation":"<p>Describes how the IAM roles required for stack set operations are created. You cannot modify <code>PermissionModel</code> if there are stack instances associated with your stack set.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html\">Grant Self-Managed Stack Set Permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html\">Grant Service-Managed Stack Set Permissions</a>.</p> </li> </ul>" + "documentation":"<p>Describes how the IAM roles required for stack set operations are created. You cannot modify <code>PermissionModel</code> if there are stack instances associated with your stack set.</p> <ul> <li> <p>With <code>self-managed</code> permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html\">Grant self-managed permissions</a>.</p> </li> <li> <p>With <code>service-managed</code> permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by Organizations. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-activate-trusted-access.html\">Activate trusted access for stack sets with Organizations</a>.</p> </li> </ul>" }, "AutoDeployment":{ "shape":"AutoDeployment", @@ -8412,7 +8856,7 @@ }, "TemplateURL":{ "shape":"TemplateURL", - "documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>" + "documentation":"<p>The URL of a file containing the template body. The URL must point to a template (max size: 1 MB) that is located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>" } }, "documentation":"<p>The input for <a>ValidateTemplate</a> action.</p>" @@ -8430,7 +8874,7 @@ }, "Capabilities":{ "shape":"Capabilities", - "documentation":"<p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p>" + "documentation":"<p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities\">Acknowledging IAM resources in CloudFormation templates</a>.</p>" }, "CapabilitiesReason":{ "shape":"CapabilitiesReason", diff --git a/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/waiters-2.json b/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/waiters-2.json index cd37c9113ee..0bfa9b00a13 100644 --- a/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/waiters-2.json +++ b/contrib/python/botocore/py3/botocore/data/cloudformation/2010-05-15/waiters-2.json @@ -324,6 +324,62 @@ } ] }, + "StackRefactorCreateComplete": { + "delay": 5, + "operation": "DescribeStackRefactor", + "maxAttempts": 120, + "description": "Wait until the stack refactor status is CREATE_COMPLETE.", + "acceptors": [ + { + "argument": "Status", + "expected": "CREATE_COMPLETE", + "matcher": "path", + "state": "success" + }, + { + "argument": "Status", + "expected": "CREATE_FAILED", + "matcher": "path", + "state": "failure" + }, + { + "expected": "ValidationError", + "matcher": "error", + "state": "failure" + } + ] + }, + "StackRefactorExecuteComplete": { + "delay": 15, + "operation": "DescribeStackRefactor", + "maxAttempts": 120, + "description": "Wait until the stack refactor status is EXECUTE_COMPLETE.", + "acceptors": [ + { + "argument": "ExecutionStatus", + "expected": "EXECUTE_COMPLETE", + "matcher": "path", + "state": "success" + }, + { + "argument": "ExecutionStatus", + "expected": "EXECUTE_FAILED", + "matcher": "path", + "state": "failure" + }, + { + "argument": "ExecutionStatus", + "expected": "ROLLBACK_COMPLETE", + "matcher": "path", + "state": "failure" + }, + { + "expected": "ValidationError", + "matcher": "error", + "state": "failure" + } + ] + }, "TypeRegistrationComplete": { "delay": 30, "operation": "DescribeTypeRegistration", diff --git a/contrib/python/botocore/py3/botocore/data/cloudfront/2020-05-31/service-2.json b/contrib/python/botocore/py3/botocore/data/cloudfront/2020-05-31/service-2.json index 450b3732517..5d35702d76e 100644 --- a/contrib/python/botocore/py3/botocore/data/cloudfront/2020-05-31/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/cloudfront/2020-05-31/service-2.json @@ -2669,7 +2669,7 @@ "documentation":"<p>The last time the Anycast static IP list was modified.</p>" } }, - "documentation":"<p>An Anycast static IP list.</p>" + "documentation":"<p>An Anycast static IP list. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/request-static-ips.html\">Request Anycast static IPs to use for allowlisting</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>" }, "AnycastIpListCollection":{ "type":"structure", @@ -4942,7 +4942,7 @@ }, "IfMatch":{ "shape":"string", - "documentation":"<p>The VPC origin to delete, if a match occurs.</p>", + "documentation":"<p>The version identifier of the VPC origin to delete. This is the <code>ETag</code> value returned in the response to <a>GetVpcOrigin</a>.</p>", "location":"header", "locationName":"If-Match" } @@ -12897,11 +12897,11 @@ }, "HTTPPort":{ "shape":"integer", - "documentation":"<p>The HTTP port for the CloudFront VPC origin endpoint configuration.</p>" + "documentation":"<p>The HTTP port for the CloudFront VPC origin endpoint configuration. The default value is <code>80</code>.</p>" }, "HTTPSPort":{ "shape":"integer", - "documentation":"<p>The HTTPS port of the CloudFront VPC origin endpoint configuration.</p>" + "documentation":"<p>The HTTPS port of the CloudFront VPC origin endpoint configuration. The default value is <code>443</code>.</p>" }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", diff --git a/contrib/python/botocore/py3/botocore/data/cloudtrail/2013-11-01/service-2.json b/contrib/python/botocore/py3/botocore/data/cloudtrail/2013-11-01/service-2.json index 524d093523f..8f59fe1b2f6 100644 --- a/contrib/python/botocore/py3/botocore/data/cloudtrail/2013-11-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/cloudtrail/2013-11-01/service-2.json @@ -533,7 +533,7 @@ {"shape":"NoManagementAccountSLRExistsException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Describes the settings for the Insights event selectors that you configured for your trail or event data store. <code>GetInsightSelectors</code> shows if CloudTrail Insights event logging is enabled on the trail or event data store, and if it is, which Insights types are enabled. If you run <code>GetInsightSelectors</code> on a trail or event data store that does not have Insights events enabled, the operation throws the exception <code>InsightNotEnabledException</code> </p> <p>Specify either the <code>EventDataStore</code> parameter to get Insights event selectors for an event data store, or the <code>TrailName</code> parameter to the get Insights event selectors for a trail. You cannot specify these parameters together.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html\">Logging CloudTrail Insights events</a> in the <i>CloudTrail User Guide</i>.</p>", + "documentation":"<p>Describes the settings for the Insights event selectors that you configured for your trail or event data store. <code>GetInsightSelectors</code> shows if CloudTrail Insights event logging is enabled on the trail or event data store, and if it is, which Insights types are enabled. If you run <code>GetInsightSelectors</code> on a trail or event data store that does not have Insights events enabled, the operation throws the exception <code>InsightNotEnabledException</code> </p> <p>Specify either the <code>EventDataStore</code> parameter to get Insights event selectors for an event data store, or the <code>TrailName</code> parameter to the get Insights event selectors for a trail. You cannot specify these parameters together.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html\">Working with CloudTrail Insights</a> in the <i>CloudTrail User Guide</i>.</p>", "idempotent":true }, "GetQueryResults":{ @@ -836,7 +836,7 @@ {"shape":"NoManagementAccountSLRExistsException"}, {"shape":"InsufficientDependencyServiceAccessPermissionException"} ], - "documentation":"<p>Configures event selectors (also referred to as <i>basic event selectors</i>) or advanced event selectors for your trail. You can use either <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If you apply <code>AdvancedEventSelectors</code> to a trail, any existing <code>EventSelectors</code> are overwritten.</p> <p>You can use <code>AdvancedEventSelectors</code> to log management events, data events for all resource types, and network activity events.</p> <p>You can use <code>EventSelectors</code> to log management events and data events for the following resource types:</p> <ul> <li> <p> <code>AWS::DynamoDB::Table</code> </p> </li> <li> <p> <code>AWS::Lambda::Function</code> </p> </li> <li> <p> <code>AWS::S3::Object</code> </p> </li> </ul> <p>You can't use <code>EventSelectors</code> to log network activity events.</p> <p>If you want your trail to log Insights events, be sure the event selector or advanced event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html\">Logging Insights events</a> in the <i>CloudTrail User Guide</i>. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events or network activity events.</p> <p>When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.</p> <p>Example</p> <ol> <li> <p>You create an event selector for a trail and specify that you want to log write-only events.</p> </li> <li> <p>The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API operations occur in your account.</p> </li> <li> <p>CloudTrail evaluates whether the events match your event selectors.</p> </li> <li> <p>The <code>RunInstances</code> is a write-only event and it matches your event selector. The trail logs the event.</p> </li> <li> <p>The <code>GetConsoleOutput</code> is a read-only event that doesn't match your event selector. The trail doesn't log the event. </p> </li> </ol> <p>The <code>PutEventSelectors</code> operation must be called from the Region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> exception is thrown.</p> <p>You can configure up to five event selectors for each trail.</p> <p>You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html\">Logging management events</a>, <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html\">Logging data events</a>, <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html\">Logging network activity events</a>, and <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html\">Quotas in CloudTrail</a> in the <i>CloudTrail User Guide</i>.</p>", + "documentation":"<p>Configures event selectors (also referred to as <i>basic event selectors</i>) or advanced event selectors for your trail. You can use either <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If you apply <code>AdvancedEventSelectors</code> to a trail, any existing <code>EventSelectors</code> are overwritten.</p> <p>You can use <code>AdvancedEventSelectors</code> to log management events, data events for all resource types, and network activity events.</p> <p>You can use <code>EventSelectors</code> to log management events and data events for the following resource types:</p> <ul> <li> <p> <code>AWS::DynamoDB::Table</code> </p> </li> <li> <p> <code>AWS::Lambda::Function</code> </p> </li> <li> <p> <code>AWS::S3::Object</code> </p> </li> </ul> <p>You can't use <code>EventSelectors</code> to log network activity events.</p> <p>If you want your trail to log Insights events, be sure the event selector or advanced event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html\">Working with CloudTrail Insights</a> in the <i>CloudTrail User Guide</i>. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events or network activity events.</p> <p>When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.</p> <p>Example</p> <ol> <li> <p>You create an event selector for a trail and specify that you want to log write-only events.</p> </li> <li> <p>The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API operations occur in your account.</p> </li> <li> <p>CloudTrail evaluates whether the events match your event selectors.</p> </li> <li> <p>The <code>RunInstances</code> is a write-only event and it matches your event selector. The trail logs the event.</p> </li> <li> <p>The <code>GetConsoleOutput</code> is a read-only event that doesn't match your event selector. The trail doesn't log the event. </p> </li> </ol> <p>The <code>PutEventSelectors</code> operation must be called from the Region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> exception is thrown.</p> <p>You can configure up to five event selectors for each trail.</p> <p>You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html\">Logging management events</a>, <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html\">Logging data events</a>, <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html\">Logging network activity events</a>, and <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html\">Quotas in CloudTrail</a> in the <i>CloudTrail User Guide</i>.</p>", "idempotent":true }, "PutInsightSelectors":{ @@ -865,7 +865,7 @@ {"shape":"NoManagementAccountSLRExistsException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store. You also use <code>PutInsightSelectors</code> to turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types are <code>ApiErrorRateInsight</code> and <code>ApiCallRateInsight</code>.</p> <p>To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source event data store (<code>EventDataStore</code>) and the destination event data store (<code>InsightsDestination</code>). The source event data store logs management events and enables Insights. The destination event data store logs Insights events based upon the management event activity of the source event data store. The source and destination event data stores must belong to the same Amazon Web Services account.</p> <p>To log Insights events for a trail, you must specify the name (<code>TrailName</code>) of the CloudTrail trail for which you want to change or add Insights selectors.</p> <p>To log CloudTrail Insights events on API call volume, the trail or event data store must log <code>write</code> management events. To log CloudTrail Insights events on API error rate, the trail or event data store must log <code>read</code> or <code>write</code> management events. You can call <code>GetEventSelectors</code> on a trail to check whether the trail logs management events. You can call <code>GetEventDataStore</code> on an event data store to check whether the event data store logs management events.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html\">Logging CloudTrail Insights events</a> in the <i>CloudTrail User Guide</i>.</p>", + "documentation":"<p>Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail or event data store. You also use <code>PutInsightSelectors</code> to turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types are <code>ApiErrorRateInsight</code> and <code>ApiCallRateInsight</code>.</p> <p>To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source event data store (<code>EventDataStore</code>) and the destination event data store (<code>InsightsDestination</code>). The source event data store logs management events and enables Insights. The destination event data store logs Insights events based upon the management event activity of the source event data store. The source and destination event data stores must belong to the same Amazon Web Services account.</p> <p>To log Insights events for a trail, you must specify the name (<code>TrailName</code>) of the CloudTrail trail for which you want to change or add Insights selectors.</p> <p>To log CloudTrail Insights events on API call volume, the trail or event data store must log <code>write</code> management events. To log CloudTrail Insights events on API error rate, the trail or event data store must log <code>read</code> or <code>write</code> management events. You can call <code>GetEventSelectors</code> on a trail to check whether the trail logs management events. You can call <code>GetEventDataStore</code> on an event data store to check whether the event data store logs management events.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html\">Working with CloudTrail Insights</a> in the <i>CloudTrail User Guide</i>.</p>", "idempotent":true }, "PutResourcePolicy":{ @@ -967,6 +967,22 @@ ], "documentation":"<p>Restores a deleted event data store specified by <code>EventDataStore</code>, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store.</p>" }, + "SearchSampleQueries":{ + "name":"SearchSampleQueries", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchSampleQueriesRequest"}, + "output":{"shape":"SearchSampleQueriesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"<p> Searches sample queries and returns a list of sample queries that are sorted by relevance. To search for sample queries, provide a natural language <code>SearchPhrase</code> in English. </p>", + "idempotent":true + }, "StartDashboardRefresh":{ "name":"StartDashboardRefresh", "http":{ @@ -1349,7 +1365,7 @@ "documentation":"<p>Contains all selector statements in an advanced event selector.</p>" } }, - "documentation":"<p>Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html\">Logging data events</a>, <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html\">Logging network activity events</a>, and <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html\">Logging management events</a> topics in the <i>CloudTrail User Guide</i>.</p> <p>You cannot apply both event selectors and advanced event selectors to a trail.</p> <p>For information about configurable advanced event selector fields, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html\">AdvancedEventSelector</a> in the <i>CloudTrailUser Guide</i>.</p>" + "documentation":"<p>Advanced event selectors let you create fine-grained selectors for CloudTrail management, data, and network activity events. They help you control costs by logging only those events that are important to you. For more information about configuring advanced event selectors, see the <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html\">Logging data events</a>, <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-network-events-with-cloudtrail.html\">Logging network activity events</a>, and <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html\">Logging management events</a> topics in the <i>CloudTrail User Guide</i>.</p> <p>You cannot apply both event selectors and advanced event selectors to a trail.</p> <p>For information about configurable advanced event selector fields, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html\">AdvancedEventSelector</a> in the <i>CloudTrail API Reference</i>.</p>" }, "AdvancedEventSelectors":{ "type":"list", @@ -1361,7 +1377,7 @@ "members":{ "Field":{ "shape":"SelectorField", - "documentation":"<p> A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html\">AdvancedFieldSelector</a> in the <i>CloudTrailUser Guide</i>.</p>" + "documentation":"<p> A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html\">AdvancedFieldSelector</a> in the <i>CloudTrail API Reference</i>.</p> <note> <p>Selectors don't support the use of wildcards like <code>*</code> . To match multiple values with a single condition, you may use <code>StartsWith</code>, <code>EndsWith</code>, <code>NotStartsWith</code>, or <code>NotEndsWith</code> to explicitly match the beginning or end of the event field.</p> </note>" }, "Equals":{ "shape":"Operator", @@ -4658,6 +4674,78 @@ }, "documentation":"<p> The settings for the source S3 bucket. </p>" }, + "SampleQueryDescription":{"type":"string"}, + "SampleQueryName":{"type":"string"}, + "SampleQueryRelevance":{"type":"float"}, + "SampleQuerySQL":{"type":"string"}, + "SearchSampleQueriesMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "SearchSampleQueriesRequest":{ + "type":"structure", + "required":["SearchPhrase"], + "members":{ + "SearchPhrase":{ + "shape":"SearchSampleQueriesSearchPhrase", + "documentation":"<p> The natural language phrase to use for the semantic search. The phrase must be in English. The length constraint is in characters, not words.</p>" + }, + "MaxResults":{ + "shape":"SearchSampleQueriesMaxResults", + "documentation":"<p> The maximum number of results to return on a single page. The default value is 10. </p>" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"<p> A token you can use to get the next page of results. The length constraint is in characters, not words. </p>" + } + } + }, + "SearchSampleQueriesResponse":{ + "type":"structure", + "members":{ + "SearchResults":{ + "shape":"SearchSampleQueriesSearchResults", + "documentation":"<p> A list of objects containing the search results ordered from most relevant to least relevant. </p>" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"<p> A token you can use to get the next page of results.</p>" + } + } + }, + "SearchSampleQueriesSearchPhrase":{ + "type":"string", + "max":1000, + "min":2, + "pattern":"^[ -~\\n]*$" + }, + "SearchSampleQueriesSearchResult":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"SampleQueryName", + "documentation":"<p> The name of a sample query. </p>" + }, + "Description":{ + "shape":"SampleQueryDescription", + "documentation":"<p> A longer description of a sample query. </p>" + }, + "SQL":{ + "shape":"SampleQuerySQL", + "documentation":"<p> The SQL code of the sample query. </p>" + }, + "Relevance":{ + "shape":"SampleQueryRelevance", + "documentation":"<p> A value between 0 and 1 indicating the similarity between the search phrase and result. </p>" + } + }, + "documentation":"<p> A search result returned by the <code>SearchSampleQueries</code> operation. </p>" + }, + "SearchSampleQueriesSearchResults":{ + "type":"list", + "member":{"shape":"SearchSampleQueriesSearchResult"} + }, "SelectorField":{ "type":"string", "max":1000, diff --git a/contrib/python/botocore/py3/botocore/data/codebuild/2016-10-06/service-2.json b/contrib/python/botocore/py3/botocore/data/codebuild/2016-10-06/service-2.json index 5f031e8d55a..821f2a6259f 100644 --- a/contrib/python/botocore/py3/botocore/data/codebuild/2016-10-06/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/codebuild/2016-10-06/service-2.json @@ -1853,7 +1853,7 @@ }, "buildType":{ "shape":"WebhookBuildType", - "documentation":"<p>Specifies the type of build this webhook will trigger.</p>" + "documentation":"<p>Specifies the type of build this webhook will trigger.</p> <note> <p> <code>RUNNER_BUILDKITE_BUILD</code> is only available for <code>NO_SOURCE</code> source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/sample-runner-buildkite.html\">Tutorial: Configure a CodeBuild-hosted Buildkite runner</a> in the <i>CodeBuild user guide</i>.</p> </note>" }, "manualCreation":{ "shape":"WrapperBoolean", @@ -4629,6 +4629,10 @@ "expired":{ "shape":"Timestamp", "documentation":"<p> The date and time a test case expires. A test case expires 30 days after it is created. An expired test case is not available to view in CodeBuild. </p>" + }, + "testSuiteName":{ + "shape":"String", + "documentation":"<p>The name of the test suite that the test case is a part of.</p>" } }, "documentation":"<p> Information about a test case created using a framework such as NUnit or Cucumber. A test case might be a unit test or a configuration test. </p>" @@ -4921,7 +4925,7 @@ }, "buildType":{ "shape":"WebhookBuildType", - "documentation":"<p>Specifies the type of build this webhook will trigger.</p>" + "documentation":"<p>Specifies the type of build this webhook will trigger.</p> <note> <p> <code>RUNNER_BUILDKITE_BUILD</code> is only available for <code>NO_SOURCE</code> source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/sample-runner-buildkite.html\">Tutorial: Configure a CodeBuild-hosted Buildkite runner</a> in the <i>CodeBuild user guide</i>.</p> </note>" } } }, @@ -4983,7 +4987,7 @@ }, "buildType":{ "shape":"WebhookBuildType", - "documentation":"<p>Specifies the type of build this webhook will trigger.</p>" + "documentation":"<p>Specifies the type of build this webhook will trigger.</p> <note> <p> <code>RUNNER_BUILDKITE_BUILD</code> is only available for <code>NO_SOURCE</code> source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/sample-runner-buildkite.html\">Tutorial: Configure a CodeBuild-hosted Buildkite runner</a> in the <i>CodeBuild user guide</i>.</p> </note>" }, "manualCreation":{ "shape":"WrapperBoolean", @@ -4996,6 +5000,14 @@ "scopeConfiguration":{ "shape":"ScopeConfiguration", "documentation":"<p>The scope configuration for global or organization webhooks.</p> <note> <p>Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.</p> </note>" + }, + "status":{ + "shape":"WebhookStatus", + "documentation":"<p>The status of the webhook. Valid values include:</p> <ul> <li> <p> <code>CREATING</code>: The webhook is being created.</p> </li> <li> <p> <code>CREATE_FAILED</code>: The webhook has failed to create.</p> </li> <li> <p> <code>ACTIVE</code>: The webhook has succeeded and is active.</p> </li> <li> <p> <code>DELETING</code>: The webhook is being deleted.</p> </li> </ul>" + }, + "statusMessage":{ + "shape":"String", + "documentation":"<p>A message associated with the status of a webhook.</p>" } }, "documentation":"<p>Information about a webhook that connects repository events to a build project in CodeBuild.</p>" @@ -5004,7 +5016,8 @@ "type":"string", "enum":[ "BUILD", - "BUILD_BATCH" + "BUILD_BATCH", + "RUNNER_BUILDKITE_BUILD" ] }, "WebhookFilter":{ @@ -5016,7 +5029,7 @@ "members":{ "type":{ "shape":"WebhookFilterType", - "documentation":"<p> The type of webhook filter. There are nine webhook filter types: <code>EVENT</code>, <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>, <code>FILE_PATH</code>, <code>COMMIT_MESSAGE</code>, <code>TAG_NAME</code>, <code>RELEASE_NAME</code>, and <code>WORKFLOW_NAME</code>. </p> <ul> <li> <p> EVENT </p> <ul> <li> <p> A webhook event triggers a build when the provided <code>pattern</code> matches one of nine event types: <code>PUSH</code>, <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>, <code>PULL_REQUEST_CLOSED</code>, <code>PULL_REQUEST_REOPENED</code>, <code>PULL_REQUEST_MERGED</code>, <code>RELEASED</code>, <code>PRERELEASED</code>, and <code>WORKFLOW_JOB_QUEUED</code>. The <code>EVENT</code> patterns are specified as a comma-separated string. For example, <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull request created, and pull request updated events. </p> <note> <p> Types <code>PULL_REQUEST_REOPENED</code> and <code>WORKFLOW_JOB_QUEUED</code> work with GitHub and GitHub Enterprise only. Types <code>RELEASED</code> and <code>PRERELEASED</code> work with GitHub only.</p> </note> </li> </ul> </li> <li> <p>ACTOR_ACCOUNT_ID</p> <ul> <li> <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression <code>pattern</code>. </p> </li> </ul> </li> <li> <p>HEAD_REF</p> <ul> <li> <p> A webhook event triggers a build when the head reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p> <note> <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.</p> </note> </li> </ul> </li> <li> <p>BASE_REF</p> <ul> <li> <p> A webhook event triggers a build when the base reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code>. </p> <note> <p> Works with pull request events only. </p> </note> </li> </ul> </li> <li> <p>FILE_PATH</p> <ul> <li> <p> A webhook triggers a build when the path of a changed file matches the regular expression <code>pattern</code>. </p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </li> </ul> </li> <li> <p>COMMIT_MESSAGE</p> <ul> <li> <p>A webhook triggers a build when the head commit message matches the regular expression <code>pattern</code>.</p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </li> </ul> </li> <li> <p>TAG_NAME</p> <ul> <li> <p>A webhook triggers a build when the tag name of the release matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p> </note> </li> </ul> </li> <li> <p>RELEASE_NAME</p> <ul> <li> <p>A webhook triggers a build when the release name matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p> </note> </li> </ul> </li> <li> <p>REPOSITORY_NAME</p> <ul> <li> <p>A webhook triggers a build when the repository name matches the regular expression pattern.</p> <note> <p> Works with GitHub global or organization webhooks only. </p> </note> </li> </ul> </li> <li> <p>WORKFLOW_NAME</p> <ul> <li> <p>A webhook triggers a build when the workflow name matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>WORKFLOW_JOB_QUEUED</code> events only. </p> </note> </li> </ul> </li> </ul>" + "documentation":"<p> The type of webhook filter. There are nine webhook filter types: <code>EVENT</code>, <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>, <code>FILE_PATH</code>, <code>COMMIT_MESSAGE</code>, <code>TAG_NAME</code>, <code>RELEASE_NAME</code>, and <code>WORKFLOW_NAME</code>. </p> <ul> <li> <p> EVENT </p> <ul> <li> <p> A webhook event triggers a build when the provided <code>pattern</code> matches one of nine event types: <code>PUSH</code>, <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>, <code>PULL_REQUEST_CLOSED</code>, <code>PULL_REQUEST_REOPENED</code>, <code>PULL_REQUEST_MERGED</code>, <code>RELEASED</code>, <code>PRERELEASED</code>, and <code>WORKFLOW_JOB_QUEUED</code>. The <code>EVENT</code> patterns are specified as a comma-separated string. For example, <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull request created, and pull request updated events. </p> <note> <p> Types <code>PULL_REQUEST_REOPENED</code> and <code>WORKFLOW_JOB_QUEUED</code> work with GitHub and GitHub Enterprise only. Types <code>RELEASED</code> and <code>PRERELEASED</code> work with GitHub only.</p> </note> </li> </ul> </li> <li> <p>ACTOR_ACCOUNT_ID</p> <ul> <li> <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression <code>pattern</code>. </p> </li> </ul> </li> <li> <p>HEAD_REF</p> <ul> <li> <p> A webhook event triggers a build when the head reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p> <note> <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.</p> </note> </li> </ul> </li> <li> <p>BASE_REF</p> <ul> <li> <p> A webhook event triggers a build when the base reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code>. </p> <note> <p> Works with pull request events only. </p> </note> </li> </ul> </li> <li> <p>FILE_PATH</p> <ul> <li> <p> A webhook triggers a build when the path of a changed file matches the regular expression <code>pattern</code>. </p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </li> </ul> </li> <li> <p>COMMIT_MESSAGE</p> <ul> <li> <p>A webhook triggers a build when the head commit message matches the regular expression <code>pattern</code>.</p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </li> </ul> </li> <li> <p>TAG_NAME</p> <ul> <li> <p>A webhook triggers a build when the tag name of the release matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p> </note> </li> </ul> </li> <li> <p>RELEASE_NAME</p> <ul> <li> <p>A webhook triggers a build when the release name matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p> </note> </li> </ul> </li> <li> <p>REPOSITORY_NAME</p> <ul> <li> <p>A webhook triggers a build when the repository name matches the regular expression pattern.</p> <note> <p> Works with GitHub global or organization webhooks only. </p> </note> </li> </ul> </li> <li> <p>WORKFLOW_NAME</p> <ul> <li> <p>A webhook triggers a build when the workflow name matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>WORKFLOW_JOB_QUEUED</code> events only. </p> </note> <note> <p>For CodeBuild-hosted Buildkite runner builds, WORKFLOW_NAME filters will filter by pipeline name.</p> </note> </li> </ul> </li> </ul>" }, "pattern":{ "shape":"String", @@ -5027,7 +5040,7 @@ "documentation":"<p> Used to indicate that the <code>pattern</code> determines which webhook events do not trigger a build. If true, then a webhook event that does not match the <code>pattern</code> triggers a build. If false, then a webhook event that matches the <code>pattern</code> triggers a build. </p>" } }, - "documentation":"<p> A filter used to determine which webhooks trigger a build. </p>" + "documentation":"<p>A filter used to determine which webhooks trigger a build. </p>" }, "WebhookFilterType":{ "type":"string", @@ -5052,6 +5065,15 @@ "GITLAB_GROUP" ] }, + "WebhookStatus":{ + "type":"string", + "enum":[ + "CREATING", + "CREATE_FAILED", + "ACTIVE", + "DELETING" + ] + }, "WrapperBoolean":{"type":"boolean"}, "WrapperDouble":{"type":"double"}, "WrapperInt":{"type":"integer"}, diff --git a/contrib/python/botocore/py3/botocore/data/codepipeline/2015-07-09/service-2.json b/contrib/python/botocore/py3/botocore/data/codepipeline/2015-07-09/service-2.json index f3b79d28d26..3ac6a239fe1 100644 --- a/contrib/python/botocore/py3/botocore/data/codepipeline/2015-07-09/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/codepipeline/2015-07-09/service-2.json @@ -342,7 +342,7 @@ {"shape":"ValidationException"}, {"shape":"InvalidNextTokenException"} ], - "documentation":"<p>Lists the rules for the condition. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a>. For more information about rules, see the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html\">CodePipeline rule reference</a>.</p>" + "documentation":"<p>Lists the rules for the condition. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a> and <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html\">How do stage conditions work?</a>.For more information about rules, see the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html\">CodePipeline rule reference</a>.</p>" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -390,7 +390,7 @@ {"shape":"NotLatestPipelineExecutionException"}, {"shape":"ConcurrentPipelineExecutionsLimitExceededException"} ], - "documentation":"<p>Used to override a stage condition.</p>" + "documentation":"<p>Used to override a stage condition. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a> and <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html\">How do stage conditions work?</a>.</p>" }, "PollForJobs":{ "name":"PollForJobs", @@ -950,6 +950,10 @@ "timeoutInMinutes":{ "shape":"ActionTimeout", "documentation":"<p>A timeout duration in minutes that can be applied against the ActionType’s default timeout value specified in <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/limits.html\">Quotas for CodePipeline </a>. This attribute is available only to the manual approval ActionType.</p>" + }, + "environmentVariables":{ + "shape":"EnvironmentVariableList", + "documentation":"<p>The environment variables for the action.</p>" } }, "documentation":"<p>Represents information about an action declaration.</p>" @@ -1763,7 +1767,7 @@ "documentation":"<p>The conditions that are configured as entry conditions.</p>" } }, - "documentation":"<p>The conditions for making checks for entry to a stage. </p>" + "documentation":"<p>The conditions for making checks for entry to a stage. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a> and <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html\">How do stage conditions work?</a>. </p>" }, "BlockerDeclaration":{ "type":"structure", @@ -1848,7 +1852,7 @@ "documentation":"<p>The rules that make up the condition.</p>" } }, - "documentation":"<p>The condition for the stage. A condition is made up of the rules and the result for the condition. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a>. For more information about rules, see the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html\">CodePipeline rule reference</a>.</p>" + "documentation":"<p>The condition for the stage. A condition is made up of the rules and the result for the condition. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a> and <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html\">How do stage conditions work?</a>.. For more information about rules, see the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html\">CodePipeline rule reference</a>.</p>" }, "ConditionExecution":{ "type":"structure", @@ -2208,6 +2212,42 @@ "type":"string", "enum":["KMS"] }, + "EnvironmentVariable":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"EnvironmentVariableName", + "documentation":"<p>The environment variable name in the key-value pair.</p>" + }, + "value":{ + "shape":"EnvironmentVariableValue", + "documentation":"<p>The environment variable value in the key-value pair.</p>" + } + }, + "documentation":"<p>The environment variables for the action.</p>" + }, + "EnvironmentVariableList":{ + "type":"list", + "member":{"shape":"EnvironmentVariable"}, + "max":10, + "min":1 + }, + "EnvironmentVariableName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[A-Za-z0-9_]+" + }, + "EnvironmentVariableValue":{ + "type":"string", + "max":2000, + "min":1, + "pattern":".*" + }, "ErrorDetails":{ "type":"structure", "members":{ @@ -2315,10 +2355,10 @@ }, "conditions":{ "shape":"ConditionList", - "documentation":"<p>The conditions that are configured as failure conditions.</p>" + "documentation":"<p>The conditions that are configured as failure conditions. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a> and <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html\">How do stage conditions work?</a>.</p>" } }, - "documentation":"<p>The configuration that specifies the result, such as rollback, to occur upon stage failure. </p>" + "documentation":"<p>The configuration that specifies the result, such as rollback, to occur upon stage failure. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a> and <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html\">How do stage conditions work?</a>. </p>" }, "FailureDetails":{ "type":"structure", @@ -2633,7 +2673,7 @@ "members":{ "events":{ "shape":"GitPullRequestEventTypeList", - "documentation":"<p>The field that specifies which pull request events to filter on (opened, updated, closed) for the trigger configuration.</p>" + "documentation":"<p>The field that specifies which pull request events to filter on (OPEN, UPDATED, CLOSED) for the trigger configuration.</p>" }, "branches":{ "shape":"GitBranchFilterCriteria", @@ -2644,7 +2684,7 @@ "documentation":"<p>The field that specifies to filter on file paths for the pull request trigger configuration.</p>" } }, - "documentation":"<p>The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.</p>" + "documentation":"<p>The event criteria for the pull request trigger configuration, such as the lists of branches or file paths to include and exclude.</p> <p>The following are valid values for the events for this filter:</p> <ul> <li> <p>CLOSED</p> </li> <li> <p>OPEN</p> </li> <li> <p>UPDATED</p> </li> </ul>" }, "GitPullRequestFilterList":{ "type":"list", @@ -4001,7 +4041,7 @@ }, "token":{ "shape":"ApprovalToken", - "documentation":"<p>The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the <a>GetPipelineState</a> action. It is used to validate that the approval request corresponding to this token is still valid.</p> <important> <p>For a pipeline where the execution mode is set to PARALLEL, the token required to approve/reject approval request as detailed above is not available. Instead, use the <code>externalExecutionId</code> from the <code>GetPipelineState</code> action as the token in the approval request.</p> </important>" + "documentation":"<p>The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the <a>GetPipelineState</a> action. It is used to validate that the approval request corresponding to this token is still valid.</p> <important> <p>For a pipeline where the execution mode is set to PARALLEL, the token required to approve/reject an approval request as detailed above is not available. Instead, use the <code>externalExecutionId</code> in the response output from the <a>ListActionExecutions</a> action as the token in the approval request.</p> </important>" } }, "documentation":"<p>Represents the input of a <code>PutApprovalResult</code> action.</p>" @@ -4457,7 +4497,7 @@ "documentation":"<p>The action timeout for the rule.</p>" } }, - "documentation":"<p>Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a>. For more information about rules, see the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html\">CodePipeline rule reference</a>.</p>" + "documentation":"<p>Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a> and <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html\">How do stage conditions work?</a>. For more information about rules, see the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html\">CodePipeline rule reference</a>.</p>" }, "RuleDeclarationList":{ "type":"list", @@ -4579,7 +4619,7 @@ "members":{ "ruleTypeId":{ "shape":"RuleTypeId", - "documentation":"<p>The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.</p>" + "documentation":"<p>The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a>. For more information about rules, see the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html\">CodePipeline rule reference</a>.</p>" }, "configuration":{ "shape":"RuleConfigurationMap", @@ -4763,14 +4803,14 @@ }, "provider":{ "shape":"RuleProvider", - "documentation":"<p>The rule provider, such as the <code>DeploymentWindow</code> rule.</p>" + "documentation":"<p>The rule provider, such as the <code>DeploymentWindow</code> rule. For a list of rule provider names, see the rules listed in the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html\">CodePipeline rule reference</a>.</p>" }, "version":{ "shape":"Version", "documentation":"<p>A string that describes the rule version.</p>" } }, - "documentation":"<p>The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.</p>" + "documentation":"<p>The ID for the rule type, which is made up of the combined values for category, owner, provider, and version. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a>. For more information about rules, see the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html\">CodePipeline rule reference</a>.</p>" }, "RuleTypeList":{ "type":"list", @@ -5228,7 +5268,7 @@ "documentation":"<p>The conditions that are success conditions.</p>" } }, - "documentation":"<p>The conditions for making checks that, if met, succeed a stage.</p>" + "documentation":"<p>The conditions for making checks that, if met, succeed a stage. For more information about conditions, see <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html\">Stage conditions</a> and <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html\">How do stage conditions work?</a>.</p>" }, "Tag":{ "type":"structure", diff --git a/contrib/python/botocore/py3/botocore/data/cognito-identity/2014-06-30/endpoint-rule-set-1.json b/contrib/python/botocore/py3/botocore/data/cognito-identity/2014-06-30/endpoint-rule-set-1.json index 348fc5c4bb0..96572525e55 100644 --- a/contrib/python/botocore/py3/botocore/data/cognito-identity/2014-06-30/endpoint-rule-set-1.json +++ b/contrib/python/botocore/py3/botocore/data/cognito-identity/2014-06-30/endpoint-rule-set-1.json @@ -167,6 +167,82 @@ ], "rules": [ { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "https://cognito-identity-fips.us-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-2" + ] + } + ], + "endpoint": { + "url": "https://cognito-identity-fips.us-east-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-1" + ] + } + ], + "endpoint": { + "url": "https://cognito-identity-fips.us-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-2" + ] + } + ], + "endpoint": { + "url": "https://cognito-identity-fips.us-west-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { "conditions": [], "endpoint": { "url": "https://cognito-identity-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", @@ -271,6 +347,31 @@ ], "rules": [ { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://cognito-identity.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { "conditions": [], "endpoint": { "url": "https://cognito-identity.{Region}.{PartitionResult#dualStackDnsSuffix}", diff --git a/contrib/python/botocore/py3/botocore/data/cognito-idp/2016-04-18/endpoint-rule-set-1.json b/contrib/python/botocore/py3/botocore/data/cognito-idp/2016-04-18/endpoint-rule-set-1.json index 0b7d7c82908..5e76d91815b 100644 --- a/contrib/python/botocore/py3/botocore/data/cognito-idp/2016-04-18/endpoint-rule-set-1.json +++ b/contrib/python/botocore/py3/botocore/data/cognito-idp/2016-04-18/endpoint-rule-set-1.json @@ -167,6 +167,82 @@ ], "rules": [ { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-1" + ] + } + ], + "endpoint": { + "url": "https://cognito-idp-fips.us-east-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-east-2" + ] + } + ], + "endpoint": { + "url": "https://cognito-idp-fips.us-east-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-1" + ] + } + ], + "endpoint": { + "url": "https://cognito-idp-fips.us-west-1.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "ref": "Region" + }, + "us-west-2" + ] + } + ], + "endpoint": { + "url": "https://cognito-idp-fips.us-west-2.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { "conditions": [], "endpoint": { "url": "https://cognito-idp-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", @@ -271,6 +347,31 @@ ], "rules": [ { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://cognito-idp.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { "conditions": [], "endpoint": { "url": "https://cognito-idp.{Region}.{PartitionResult#dualStackDnsSuffix}", diff --git a/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json b/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json index 1befa2930dd..8e2e8883e42 100644 --- a/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/connect/2017-08-08/service-2.json @@ -275,7 +275,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"<p>>Associates a set of proficiencies with a user.</p>" + "documentation":"<p>Associates a set of proficiencies with a user.</p>" }, "BatchAssociateAnalyticsDataSet":{ "name":"BatchAssociateAnalyticsDataSet", @@ -438,7 +438,7 @@ {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Creates a new contact.</p>" + "documentation":"<important> <p>Only the EMAIL channel is supported. The supported initiation methods are: OUTBOUND, AGENT_REPLY, and FLOW.</p> </important> <p>Creates a new EMAIL contact. </p>" }, "CreateContactFlow":{ "name":"CreateContactFlow", @@ -499,7 +499,7 @@ {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If a version of the same flow content already exists, no new version is created and instead the existing version number is returned. If the <code>FlowContentSha256</code> provided is different from the <code>FlowContentSha256</code> of the <code>$LATEST</code> published flow content, then an error is returned. This API only supports creating versions for flows of type <code>Campaign</code>.</p>" + "documentation":"<p>Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the <code>FlowContentSha256</code> provided is different from the <code>FlowContentSha256</code> of the <code>$LATEST</code> published flow content, then an error is returned. This API only supports creating versions for flows of type <code>Campaign</code>.</p>" }, "CreateEmailAddress":{ "name":"CreateEmailAddress", @@ -1040,6 +1040,24 @@ ], "documentation":"<p>Deletes the specified flow module.</p>" }, + "DeleteContactFlowVersion":{ + "name":"DeleteContactFlowVersion", + "http":{ + "method":"DELETE", + "requestUri":"/contact-flows/{InstanceId}/{ContactFlowId}/version/{ContactFlowVersion}" + }, + "input":{"shape":"DeleteContactFlowVersionRequest"}, + "output":{"shape":"DeleteContactFlowVersionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Deletes the particular version specified in flow version identifier.</p>" + }, "DeleteEmailAddress":{ "name":"DeleteEmailAddress", "http":{ @@ -1203,7 +1221,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"<p>Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.</p>" + "documentation":"<p>Deletes a queue.</p>" }, "DeleteQuickConnect":{ "name":"DeleteQuickConnect", @@ -1442,7 +1460,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.</p> <p>Describes the target authentication profile.</p>" + "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.</p> <p>Describes the target authentication profile.</p>" }, "DescribeContact":{ "name":"DescribeContact", @@ -1459,7 +1477,7 @@ {"shape":"InternalServiceException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified contact. </p> <important> <p>Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API</p> </important>" + "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Describes the specified contact. </p> <important> <ul> <li> <p> <code>CustomerEndpoint</code> and <code>SystemEndpoint</code> are only populated for EMAIL contacts. </p> </li> <li> <p>Contact information remains available in Amazon Connect for 24 months from the <code>InitiationTimestamp</code>, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.</p> </li> </ul> </important>" }, "DescribeContactEvaluation":{ "name":"DescribeContactEvaluation", @@ -1493,7 +1511,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"<p>Describes the specified flow.</p> <p>You can also create and update flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html\">Amazon Connect Flow language</a>.</p> <p>Use the <code>$SAVED</code> alias in the request to describe the <code>SAVED</code> content of a Flow. For example, <code>arn:aws:.../contact-flow/{id}:$SAVED</code>. After a flow is published, <code>$SAVED</code> needs to be supplied to view saved content that has not been published.</p> <p>In the response, <b>Status</b> indicates the flow status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code> status will initiate validation on the content. <code>SAVED</code> does not initiate validation of the content. <code>SAVED</code> | <code>PUBLISHED</code> </p>" + "documentation":"<p>Describes the specified flow.</p> <p>You can also create and update flows using the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html\">Amazon Connect Flow language</a>.</p> <p>Use the <code>$SAVED</code> alias in the request to describe the <code>SAVED</code> content of a Flow. For example, <code>arn:aws:.../contact-flow/{id}:$SAVED</code>. After a flow is published, <code>$SAVED</code> needs to be supplied to view saved content that has not been published.</p> <p>Use <code>arn:aws:.../contact-flow/{id}:{version}</code> to retrieve the content of a specific flow version.</p> <p>In the response, <b>Status</b> indicates the flow status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code> status will initiate validation on the content. <code>SAVED</code> does not initiate validation of the content. <code>SAVED</code> | <code>PUBLISHED</code> </p>" }, "DescribeContactFlowModule":{ "name":"DescribeContactFlowModule", @@ -2319,7 +2337,7 @@ {"shape":"IdempotencyException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.</p> <important> <p>Call the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html\">DescribePhoneNumber</a> API to verify the status of a previous <code>ImportPhoneNumber</code> operation. </p> </important> <p>If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. </p> <p> By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. </p> <p>For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket. </p>" + "documentation":"<p>Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.</p> <important> <p>Call the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html\">DescribePhoneNumber</a> API to verify the status of a previous <code>ImportPhoneNumber</code> operation. </p> </important> <p>If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. </p> <p> By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. </p> <p>For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web ServicesSupport ticket. </p>" }, "ListAgentStatuses":{ "name":"ListAgentStatuses", @@ -2355,6 +2373,23 @@ ], "documentation":"<p>Lists the association status of requested dataset ID for a given Amazon Connect instance.</p>" }, + "ListAnalyticsDataLakeDataSets":{ + "name":"ListAnalyticsDataLakeDataSets", + "http":{ + "method":"GET", + "requestUri":"/analytics-data/instance/{InstanceId}/datasets" + }, + "input":{"shape":"ListAnalyticsDataLakeDataSetsRequest"}, + "output":{"shape":"ListAnalyticsDataLakeDataSetsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"<p>Lists the data lake datasets available to associate with for a given Amazon Connect instance.</p>" + }, "ListApprovedOrigins":{ "name":"ListApprovedOrigins", "http":{ @@ -2404,7 +2439,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.</p> <p>Provides summary information about the authentication profiles in a specified Amazon Connect instance.</p>" + "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.</p> <p>Provides summary information about the authentication profiles in a specified Amazon Connect instance.</p>" }, "ListBots":{ "name":"ListBots", @@ -3205,7 +3240,7 @@ {"shape":"IdempotencyException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.</p> <important> <p>To release phone numbers from a traffic distribution group, use the <code>ReleasePhoneNumber</code> API, not the Amazon Connect admin website.</p> <p>After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support.</p> </important> <p>If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.</p> <p>By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. </p> <p>For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.</p>" + "documentation":"<p>Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed.</p> <important> <p>To release phone numbers from a traffic distribution group, use the <code>ReleasePhoneNumber</code> API, not the Amazon Connect admin website.</p> <p>After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web ServicesSupport.</p> </important> <p>If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.</p> <p>By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. </p> <p>For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.</p>" }, "ReplicateInstance":{ "name":"ReplicateInstance", @@ -3636,7 +3671,7 @@ {"shape":"InternalServiceException"}, {"shape":"LimitExceededException"} ], - "documentation":"<p>Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> API in the Amazon Connect Participant Service.</p> <p>When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </p> <p>A 429 error occurs in the following situations:</p> <ul> <li> <p>API rate limit is exceeded. API TPS throttling returns a <code>TooManyRequests</code> exception.</p> </li> <li> <p>The <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">quota for concurrent active chats</a> is exceeded. Active chat throttling returns a <code>LimitExceededException</code>.</p> </li> </ul> <p>If you use the <code>ChatDurationInMinutes</code> parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. </p> <p>For more information about chat, see the following topics in the <i>Amazon Connect Administrator Guide</i>: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html\">Concepts: Web and mobile messaging capabilities in Amazon Connect</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat\">Amazon Connect Chat security best practices</a> </p> </li> </ul>" + "documentation":"<p>Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> API in the Amazon Connect Participant Service.</p> <p>When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </p> <p>A 429 error occurs in the following situations:</p> <ul> <li> <p>API rate limit is exceeded. API TPS throttling returns a <code>TooManyRequests</code> exception.</p> </li> <li> <p>The <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">quota for concurrent active chats</a> is exceeded. Active chat throttling returns a <code>LimitExceededException</code>.</p> </li> </ul> <p>If you use the <code>ChatDurationInMinutes</code> parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web ServicesSupport. </p> <p>For more information about chat, see the following topics in the <i>Amazon Connect Administrator Guide</i>: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html\">Concepts: Web and mobile messaging capabilities in Amazon Connect</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat\">Amazon Connect Chat security best practices</a> </p> </li> </ul>" }, "StartContactEvaluation":{ "name":"StartContactEvaluation", @@ -4018,7 +4053,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.</p> <p>Updates the selected authentication profile.</p>" + "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.</p> <p>Updates the selected authentication profile.</p>" }, "UpdateContact":{ "name":"UpdateContact", @@ -4690,7 +4725,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"<p>Updates the traffic distribution for a given traffic distribution group. </p> <note> <p>The <code>SignInConfig</code> distribution is available only on a default <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html\">TrafficDistributionGroup</a> data type). If you call <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>, an <code>InvalidRequestException</code> is returned.</p> </note> <p>For more information about updating a traffic distribution group, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html\">Update telephony traffic distribution across Amazon Web Services Regions </a> in the <i>Amazon Connect Administrator Guide</i>. </p>" + "documentation":"<p>Updates the traffic distribution for a given traffic distribution group. </p> <important> <p>When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls.</p> </important> <note> <p>The <code>SignInConfig</code> distribution is available only on a default <code>TrafficDistributionGroup</code> (see the <code>IsDefault</code> parameter in the <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html\">TrafficDistributionGroup</a> data type). If you call <code>UpdateTrafficDistribution</code> with a modified <code>SignInConfig</code> and a non-default <code>TrafficDistributionGroup</code>, an <code>InvalidRequestException</code> is returned.</p> </note> <p>For more information about updating a traffic distribution group, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html\">Update telephony traffic distribution across Amazon Web Services Regions </a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "UpdateUserHierarchy":{ "name":"UpdateUserHierarchy", @@ -5374,6 +5409,10 @@ "ResourceShareArn":{ "shape":"ARN", "documentation":"<p>The Amazon Resource Name (ARN) of the Resource Access Manager share. </p>" + }, + "ResourceShareStatus":{ + "shape":"String", + "documentation":"<p>The Amazon Web Services Resource Access Manager status of association.</p>" } }, "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change.</p> <p>Information about associations that are successfully created: <code>DataSetId</code>, <code>TargetAccountId</code>, <code>ResourceShareId</code>, <code>ResourceShareArn</code>. </p>" @@ -5382,6 +5421,24 @@ "type":"list", "member":{"shape":"AnalyticsDataAssociationResult"} }, + "AnalyticsDataSetsResult":{ + "type":"structure", + "members":{ + "DataSetId":{ + "shape":"DataSetId", + "documentation":"<p>The identifier of the dataset.</p>" + }, + "DataSetName":{ + "shape":"String", + "documentation":"<p>The name of the dataset.</p>" + } + }, + "documentation":"<p>Information about datasets that are available to associate with: <code>DataSetId</code>, <code>DataSetName</code>.</p>" + }, + "AnalyticsDataSetsResults":{ + "type":"list", + "member":{"shape":"AnalyticsDataSetsResult"} + }, "AnswerMachineDetectionConfig":{ "type":"structure", "members":{ @@ -5520,6 +5577,11 @@ "Origin":{ "shape":"Origin", "documentation":"<p>The domain to add to your allow list.</p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true } } }, @@ -5537,6 +5599,11 @@ "LexV2Bot":{ "shape":"LexV2Bot", "documentation":"<p>The Amazon Lex V2 bot to associate with the instance.</p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true } } }, @@ -5625,6 +5692,11 @@ "StorageConfig":{ "shape":"InstanceStorageConfig", "documentation":"<p>A valid storage type.</p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true } } }, @@ -5653,6 +5725,11 @@ "FunctionArn":{ "shape":"FunctionArn", "documentation":"<p>The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.</p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true } } }, @@ -5672,6 +5749,11 @@ "LexBot":{ "shape":"LexBot", "documentation":"<p>The Amazon Lex bot to associate with the instance.</p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true } } }, @@ -5767,6 +5849,11 @@ "Key":{ "shape":"PEM", "documentation":"<p>A valid security key in PEM format as a String.</p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true } } }, @@ -6196,7 +6283,7 @@ "documentation":"<p>The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts\">Configure the session duration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" } }, - "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.</p> <p>Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html\">Set IP address restrictions or session timeouts</a>. </p>" + "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.</p> <p>Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html\">Set IP address restrictions or session timeouts</a>. </p>" }, "AuthenticationProfileDescription":{ "type":"string", @@ -6241,7 +6328,7 @@ "documentation":"<p>The Amazon Web Services Region when the authentication profile summary was last modified.</p>" } }, - "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.</p> <p>A summary of a given authentication profile.</p>" + "documentation":"<p>This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web ServicesSupport.</p> <p>A summary of a given authentication profile.</p>" }, "AuthenticationProfileSummaryList":{ "type":"list", @@ -7381,7 +7468,8 @@ "AGENT_WHISPER", "OUTBOUND_WHISPER", "AGENT_TRANSFER", - "QUEUE_TRANSFER" + "QUEUE_TRANSFER", + "CAMPAIGN" ] }, "ContactFlowTypes":{ @@ -7832,7 +7920,7 @@ }, "FlowContentSha256":{ "shape":"FlowContentSha256", - "documentation":"<p>Indicates the checksum value of the flow content.</p>" + "documentation":"<p>Indicates the checksum value of the latest published flow content.</p>" } } }, @@ -7863,6 +7951,10 @@ "shape":"FlowContentSha256", "documentation":"<p>Indicates the checksum value of the flow content.</p>" }, + "ContactFlowVersion":{ + "shape":"ResourceVersion", + "documentation":"<p>The identifier of the flow version.</p>" + }, "LastModifiedTime":{ "shape":"Timestamp", "documentation":"<p>The Amazon Web Services Region where this resource was last modified.</p>" @@ -7917,11 +8009,11 @@ }, "Channel":{ "shape":"Channel", - "documentation":"<p>The channel for the contact</p>" + "documentation":"<p>The channel for the contact</p> <important> <p>CreateContact only supports the EMAIL channel. The following information that states other channels are supported is incorrect. We are working to update this topic.</p> </important>" }, "InitiationMethod":{ "shape":"ContactInitiationMethod", - "documentation":"<p>Indicates how the contact was initiated.</p>" + "documentation":"<p>Indicates how the contact was initiated. </p> <important> <p>CreateContact only supports the following initiation methods: OUTBOUND, AGENT_REPLY, and FLOW. The following information that states other initiation methods are supported is incorrect. We are working to update this topic.</p> </important>" }, "ExpiryDurationInMinutes":{ "shape":"ExpiryDurationInMinutes", @@ -8178,7 +8270,8 @@ "members":{ "ClientToken":{ "shape":"ClientToken", - "documentation":"<p>The idempotency token.</p>" + "documentation":"<p>The idempotency token.</p>", + "idempotencyToken":true }, "IdentityManagementType":{ "shape":"DirectoryType", @@ -8742,7 +8835,7 @@ }, "TagRestrictedResources":{ "shape":"TagRestrictedResourceList", - "documentation":"<p>The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: <code>User</code> | <code>SecurityProfile</code> | <code>Queue</code> | <code>RoutingProfile</code> </p>" + "documentation":"<p>The list of resources that a security profile applies tag restrictions to in Amazon Connect. For a list of Amazon Connect resources that you can tag, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html\">Add tags to resources in Amazon Connect</a> in the <i>Amazon Connect Administrator Guide</i>. </p>" }, "Applications":{ "shape":"Applications", @@ -9617,6 +9710,39 @@ "members":{ } }, + "DeleteContactFlowVersionRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "ContactFlowId", + "ContactFlowVersion" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", + "location":"uri", + "locationName":"InstanceId" + }, + "ContactFlowId":{ + "shape":"ARN", + "documentation":"<p>The identifier of the flow.</p>", + "location":"uri", + "locationName":"ContactFlowId" + }, + "ContactFlowVersion":{ + "shape":"ResourceVersion", + "documentation":"<p>The identifier of the flow version.</p>", + "location":"uri", + "locationName":"ContactFlowVersion" + } + } + }, + "DeleteContactFlowVersionResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteEmailAddressRequest":{ "type":"structure", "required":[ @@ -9729,6 +9855,13 @@ "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", "location":"uri", "locationName":"InstanceId" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" } } }, @@ -11135,6 +11268,13 @@ "documentation":"<p>The domain URL of the integrated application.</p>", "location":"querystring", "locationName":"origin" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" } } }, @@ -11152,6 +11292,11 @@ "LexV2Bot":{ "shape":"LexV2Bot", "documentation":"<p>The Amazon Lex V2 bot to disassociate from the instance.</p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true } } }, @@ -11213,6 +11358,13 @@ "documentation":"<p>A valid resource type.</p>", "location":"querystring", "locationName":"resourceType" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" } } }, @@ -11234,6 +11386,13 @@ "documentation":"<p>The Amazon Resource Name (ARN) of the Lambda function being disassociated.</p>", "location":"querystring", "locationName":"functionArn" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" } } }, @@ -11262,6 +11421,13 @@ "documentation":"<p>The Amazon Web Services Region in which the Amazon Lex bot has been created.</p>", "location":"querystring", "locationName":"lexRegion" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" } } }, @@ -11356,6 +11522,13 @@ "documentation":"<p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>", "location":"uri", "locationName":"AssociationId" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" } } }, @@ -13430,15 +13603,15 @@ }, "Filters":{ "shape":"FiltersV2List", - "documentation":"<p>The filters to apply to returned metrics. You can filter on the following resources:</p> <ul> <li> <p>Agents</p> </li> <li> <p>Campaigns</p> </li> <li> <p>Channels</p> </li> <li> <p>Feature</p> </li> <li> <p>Queues</p> </li> <li> <p>Routing profiles</p> </li> <li> <p>Routing step expression</p> </li> <li> <p>User hierarchy groups</p> </li> </ul> <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.</p> <p>For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.</p> <p>To filter by phone number, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html\">Create a historical metrics report</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>Note the following limits:</p> <ul> <li> <p> <b>Filter keys</b>: A maximum of 5 filter keys are supported in a single request. Valid filter keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code> BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |<code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> | <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> | <code>FEATURE</code> | <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOWS_NEXT_RESOURCE_ID</code> | <code>FLOWS_NEXT_RESOURCE_QUEUE_ID</code> | <code>FLOWS_OUTCOME_TYPE</code> | <code>FLOWS_RESOURCE_ID</code> | <code>INITIATION_METHOD</code> | <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> | <code>Q_CONNECT_ENABLED</code> | </p> </li> <li> <p> <b>Filter values</b>: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid <code>filterValue</code> for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters. </p> <p> <code>contact_lens_conversational_analytics</code> is a valid filterValue for the <code>FEATURE</code> filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.</p> <p> <code>connect:Chat</code>, <code>connect:SMS</code>, <code>connect:Telephony</code>, and <code>connect:WebRTC</code> are valid <code>filterValue</code> examples (not exhaustive) for the <code>contact/segmentAttributes/connect:Subtype filter</code> key.</p> <p> <code>ROUTING_STEP_EXPRESSION</code> is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.</p> <p> <code>Q_CONNECT_ENABLED</code>. TRUE and FALSE are the only valid filterValues for the <code>Q_CONNECT_ENABLED</code> filter key. </p> <ul> <li> <p>TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.</p> </li> <li> <p>FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow</p> </li> </ul> <p>This filter is available only for contact record-driven metrics. </p> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html\">Campaign</a> ARNs are valid <code>filterValues</code> for the <code>CAMPAIGN</code> filter key.</p> </li> </ul>" + "documentation":"<p>The filters to apply to returned metrics. You can filter on the following resources:</p> <ul> <li> <p>Agents</p> </li> <li> <p>Campaigns</p> </li> <li> <p>Channels</p> </li> <li> <p>Feature</p> </li> <li> <p>Queues</p> </li> <li> <p>Routing profiles</p> </li> <li> <p>Routing step expression</p> </li> <li> <p>User hierarchy groups</p> </li> </ul> <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.</p> <p>For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.</p> <p>To filter by phone number, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html\">Create a historical metrics report</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>Note the following limits:</p> <ul> <li> <p> <b>Filter keys</b>: A maximum of 5 filter keys are supported in a single request. Valid filter keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code> BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |<code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> | <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> | <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> | <code>EVALUATION_QUESTION</code> | <code>EVALUATION_SOURCE</code> | <code>FEATURE</code> | <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOWS_NEXT_RESOURCE_ID</code> | <code>FLOWS_NEXT_RESOURCE_QUEUE_ID</code> | <code>FLOWS_OUTCOME_TYPE</code> | <code>FLOWS_RESOURCE_ID</code> | <code>FORM_VERSION</code> | <code>INITIATION_METHOD</code> | <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> | <code>Q_CONNECT_ENABLED</code> | </p> </li> <li> <p> <b>Filter values</b>: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid <code>filterValue</code> for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters. </p> <p> <code>contact_lens_conversational_analytics</code> is a valid filterValue for the <code>FEATURE</code> filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.</p> <p> <code>connect:Chat</code>, <code>connect:SMS</code>, <code>connect:Telephony</code>, and <code>connect:WebRTC</code> are valid <code>filterValue</code> examples (not exhaustive) for the <code>contact/segmentAttributes/connect:Subtype filter</code> key.</p> <p> <code>ROUTING_STEP_EXPRESSION</code> is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.</p> <p> <code>Q_CONNECT_ENABLED</code>. TRUE and FALSE are the only valid filterValues for the <code>Q_CONNECT_ENABLED</code> filter key. </p> <ul> <li> <p>TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.</p> </li> <li> <p>FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow</p> </li> </ul> <p>This filter is available only for contact record-driven metrics. </p> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html\">Campaign</a> ARNs are valid <code>filterValues</code> for the <code>CAMPAIGN</code> filter key.</p> </li> </ul>" }, "Groupings":{ "shape":"GroupingsV2", - "documentation":"<p>The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.</p> <p>If no grouping is specified, a summary of all metrics is returned.</p> <p>Valid grouping keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> | <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> | <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> | <code>FLOWS_RESOURCE_ID</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_OUTCOME_TYPE</code> | <code>INITIATION_METHOD</code> | <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> </p>" + "documentation":"<p>The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.</p> <p>If no grouping is specified, a summary of all metrics is returned.</p> <p>Valid grouping keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> | <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> | <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> | <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> | <code>EVALUATION_QUESTION</code> | <code>EVALUATION_SOURCE</code> | <code>FLOWS_RESOURCE_ID</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_OUTCOME_TYPE</code> | <code>FORM_VERSION</code> | <code>INITIATION_METHOD</code> | <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> </p> <p>Type: Array of strings</p> <p>Array Members: Maximum number of 4 items</p> <p>Required: No</p>" }, "Metrics":{ "shape":"MetricsV2", - "documentation":"<p>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html\">Historical metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <dl> <dt>ABANDONMENT_RATE</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#abandonment-rate-historical\">Abandonment rate</a> </p> </dd> <dt>AGENT_ADHERENT_TIME</dt> <dd> <p>This metric is available only in Amazon Web Services Regions where <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region\">Forecasting, capacity planning, and scheduling</a> is available.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherent-time-historical\">Adherent time</a> </p> </dd> <dt>AGENT_ANSWER_RATE</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-answer-rate-historical\">Agent answer rate</a> </p> </dd> <dt>AGENT_NON_ADHERENT_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#non-adherent-time\">Non-adherent time</a> </p> </dd> <dt>AGENT_NON_RESPONSE</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-non-response\">Agent non-response</a> </p> </dd> <dt>AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>Data for this metric is available starting from October 1, 2023 0:00:00 GMT.</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-nonresponse-no-abandon-historical\">Agent non-response without customer abandons</a> </p> </dd> <dt>AGENT_OCCUPANCY</dt> <dd> <p>Unit: Percentage</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#occupancy-historical\">Occupancy</a> </p> </dd> <dt>AGENT_SCHEDULE_ADHERENCE</dt> <dd> <p>This metric is available only in Amazon Web Services Regions where <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region\">Forecasting, capacity planning, and scheduling</a> is available.</p> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherence-historical\">Adherence</a> </p> </dd> <dt>AGENT_SCHEDULED_TIME</dt> <dd> <p>This metric is available only in Amazon Web Services Regions where <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region\">Forecasting, capacity planning, and scheduling</a> is available.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#scheduled-time-historical\">Scheduled time</a> </p> </dd> <dt>AVG_ABANDON_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-abandon-time-historical\">Average queue abandon time</a> </p> </dd> <dt>AVG_ACTIVE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-active-time-historical\">Average active time</a> </p> </dd> <dt>AVG_AFTER_CONTACT_WORK_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-acw-time-historical\">Average after contact work time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_AGENT_CONNECTING_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code>. For now, this metric only supports the following as <code>INITIATION_METHOD</code>: <code>INBOUND</code> | <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-avg-agent-api-connecting-time\">Average agent API connecting time</a> </p> <note> <p>The <code>Negate</code> key in metric-level filters is not applicable for this metric.</p> </note> </dd> <dt>AVG_AGENT_PAUSE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-pause-time-historical\">Average agent pause time</a> </p> </dd> <dt>AVG_BOT_CONVERSATION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-time-metric\">Average bot conversation time</a> </p> </dd> <dt>AVG_BOT_CONVERSATION_TURNS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-turns-metric\">Average bot conversation turns</a> </p> </dd> <dt>AVG_CASE_RELATED_CONTACTS</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contacts-case-historical\">Average contacts per case</a> </p> </dd> <dt>AVG_CASE_RESOLUTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-case-resolution-time-historical\">Average case resolution time</a> </p> </dd> <dt>AVG_CONTACT_DURATION</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contact-duration-historical\">Average contact duration</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_CONVERSATION_DURATION</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical\">Average conversation duration</a> </p> </dd> <dt>AVG_DIALS_PER_MINUTE</dt> <dd> <p>This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Campaign, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-dials-historical\">Average dials per minute</a> </p> </dd> <dt>AVG_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-flow-time-historical\">Average flow time</a> </p> </dd> <dt>AVG_GREETING_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-greeting-time-agent-historical\">Average agent greeting time</a> </p> </dd> <dt>AVG_HANDLE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-handle-time-historical\">Average handle time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_HOLD_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-customer-hold-time-historical\">Average customer hold time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_HOLD_TIME_ALL_CONTACTS</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#avg-customer-hold-time-all-contacts-historical\">Average customer hold time all contacts</a> </p> </dd> <dt>AVG_HOLDS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-holds-historical\">Average holds</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_INTERACTION_AND_HOLD_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-customer-hold-time-historical\">Average agent interaction and customer hold time</a> </p> </dd> <dt>AVG_INTERACTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-time-historical\">Average agent interaction time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_INTERRUPTIONS_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-agent-historical\">Average agent interruptions</a> </p> </dd> <dt>AVG_INTERRUPTION_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-time-agent-historical\">Average agent interruption time</a> </p> </dd> <dt>AVG_NON_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##average-non-talk-time-historical\">Average non-talk time</a> </p> </dd> <dt>AVG_QUEUE_ANSWER_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-answer-time-historical\">Average queue answer time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_RESOLUTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-resolution-time-historical\">Average resolution time</a> </p> </dd> <dt>AVG_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-historical\">Average talk time</a> </p> </dd> <dt>AVG_TALK_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical\">Average agent talk time</a> </p> </dd> <dt>AVG_TALK_TIME_CUSTOMER</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical\">Average customer talk time</a> </p> </dd> <dt>AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION</dt> <dd> <p>This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Campaign</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-wait-time-historical\">Average wait time after customer connection</a> </p> </dd> <dt>BOT_CONVERSATIONS_COMPLETED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric\">Bot conversations</a> </p> </dd> <dt>BOT_INTENTS_COMPLETED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric\">Bot intents completed</a> </p> </dd> <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X</dt> <dd> <p>This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Campaign</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>GT</code> (for <i>Greater than</i>).</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-historical\">Campaign contacts abandoned after X</a> </p> </dd> <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE</dt> <dd> <p>This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Percent</p> <p>Valid groupings and filters: Agent, Campaign</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>GT</code> (for <i>Greater than</i>).</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-rate-historical\">Campaign contacts abandoned after X rate</a> </p> </dd> <dt>CAMPAIGN_INTERACTIONS</dt> <dd> <p>This metric is available only for outbound campaigns using the email delivery mode. </p> <p>Unit: Count</p> <p>Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE</p> <p>Valid groupings and filters: Campaign</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-interactions-historical\">Campaign interactions</a> </p> </dd> <dt>CAMPAIGN_SEND_ATTEMPTS</dt> <dd> <p>This metric is available only for outbound campaigns.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-send-attempts-historical\">Campaign send attempts</a> </p> </dd> <dt>CASES_CREATED</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-created-historical\">Cases created</a> </p> </dd> <dt>CONTACTS_CREATED</dt> <dd> <p>Unit: Count</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical\">Contacts created</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>CONTACTS_HANDLED</dt> <dd> <p>Unit: Count</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical\">API contacts handled</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT</dt> <dd> <p>Unit: Count</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical\">Contacts handled (connected to agent timestamp)</a> </p> </dd> <dt>CONTACTS_HOLD_ABANDONS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical\">Contacts hold disconnect</a> </p> </dd> <dt>CONTACTS_ON_HOLD_AGENT_DISCONNECT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical\">Contacts hold agent disconnect</a> </p> </dd> <dt>CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical\">Contacts hold customer disconnect</a> </p> </dd> <dt>CONTACTS_PUT_ON_HOLD</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical\">Contacts put on hold</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_EXTERNAL</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical\">Contacts transferred out external</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_INTERNAL</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical\">Contacts transferred out internal</a> </p> </dd> <dt>CONTACTS_QUEUED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical\">Contacts queued</a> </p> </dd> <dt>CONTACTS_QUEUED_BY_ENQUEUE</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical\">Contacts queued (enqueue timestamp)</a> </p> </dd> <dt>CONTACTS_REMOVED_FROM_QUEUE_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-removed-historical\">Contacts removed from queue in X seconds</a> </p> </dd> <dt>CONTACTS_RESOLVED_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical\">Contacts resolved in X</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical\">Contacts transferred out</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>CONTACTS_TRANSFERRED_OUT_BY_AGENT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical\">Contacts transferred out by agent</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical\">Contacts transferred out queue</a> </p> </dd> <dt>CURRENT_CASES</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical\">Current cases</a> </p> </dd> <dt>DELIVERY_ATTEMPTS</dt> <dd> <p>This metric is available only for outbound campaigns.</p> <p>Unit: Count</p> <p>Valid metric filter key: <code>ANSWERING_MACHINE_DETECTION_STATUS</code>, <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code>, <code>DISCONNECT_REASON</code> </p> <p>Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempts-historical\">Delivery attempts</a> </p> <note> <p>Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes. </p> </note> </dd> <dt>DELIVERY_ATTEMPT_DISPOSITION_RATE</dt> <dd> <p>This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.</p> <p>Unit: Percent</p> <p>Valid metric filter key: <code>ANSWERING_MACHINE_DETECTION_STATUS</code>, <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code>, <code>DISCONNECT_REASON</code> </p> <p>Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempt-disposition-rate-historical\">Delivery attempt disposition rate</a> </p> <note> <p>Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes. </p> </note> </dd> <dt>FLOWS_OUTCOME</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical\">Flows outcome</a> </p> </dd> <dt>FLOWS_STARTED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical\">Flows started</a> </p> </dd> <dt>HUMAN_ANSWERED_CALLS</dt> <dd> <p>This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled. </p> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Campaign</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#human-answered-historical\">Human answered</a> </p> </dd> <dt>MAX_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical\">Maximum flow time</a> </p> </dd> <dt>MAX_QUEUED_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical\">Maximum queued time</a> </p> </dd> <dt>MIN_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical\">Minimum flow time</a> </p> </dd> <dt>PERCENT_BOT_CONVERSATIONS_OUTCOME</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-conversations-outcome-metric\">Percent bot conversations outcome</a> </p> </dd> <dt>PERCENT_BOT_INTENTS_OUTCOME</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome-metric\">Percent bot intents outcome</a> </p> </dd> <dt>PERCENT_CASES_FIRST_CONTACT_RESOLVED</dt> <dd> <p>Unit: Percent</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical\">Cases resolved on first contact</a> </p> </dd> <dt>PERCENT_CONTACTS_STEP_EXPIRED</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, RoutingStepExpression</p> <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</p> </dd> <dt>PERCENT_CONTACTS_STEP_JOINED</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, RoutingStepExpression</p> <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</p> </dd> <dt>PERCENT_FLOWS_OUTCOME</dt> <dd> <p>Unit: Percent</p> <p>Valid metric filter key: <code>FLOWS_OUTCOME_TYPE</code> </p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical\">Flows outcome percentage</a>.</p> <note> <p>The <code>FLOWS_OUTCOME_TYPE</code> is not a valid grouping.</p> </note> </dd> <dt>PERCENT_NON_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical\">Non-talk time percent</a> </p> </dd> <dt>PERCENT_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical\">Talk time percent</a> </p> </dd> <dt>PERCENT_TALK_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical\">Agent talk time percent</a> </p> </dd> <dt>PERCENT_TALK_TIME_CUSTOMER</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical\">Customer talk time percent</a> </p> </dd> <dt>REOPENED_CASE_ACTIONS</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical\">Cases reopened</a> </p> </dd> <dt>RESOLVED_CASE_ACTIONS</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historical\">Cases resolved</a> </p> </dd> <dt>SERVICE_LEVEL</dt> <dd> <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical\">Service level X</a> </p> </dd> <dt>STEP_CONTACTS_QUEUED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, RoutingStepExpression</p> <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</p> </dd> <dt>SUM_AFTER_CONTACT_WORK_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical\">After contact work time</a> </p> </dd> <dt>SUM_CONNECTING_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code>. This metric only supports the following filter keys as <code>INITIATION_METHOD</code>: <code>INBOUND</code> | <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time\">Agent API connecting time</a> </p> <note> <p>The <code>Negate</code> key in metric-level filters is not applicable for this metric.</p> </note> </dd> <dt>CONTACTS_ABANDONED</dt> <dd> <p>Unit: Count</p> <p>Metric filter: </p> <ul> <li> <p>Valid values: <code>API</code>| <code>Incoming</code> | <code>Outbound</code> | <code>Transfer</code> | <code>Callback</code> | <code>Queue_Transfer</code>| <code>Disconnect</code> </p> </li> </ul> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical\">Contact abandoned</a> </p> </dd> <dt>SUM_CONTACTS_ABANDONED_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical\">Contacts abandoned in X seconds</a> </p> </dd> <dt>SUM_CONTACTS_ANSWERED_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical\">Contacts answered in X seconds</a> </p> </dd> <dt>SUM_CONTACT_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical\">Contact flow time</a> </p> </dd> <dt>SUM_CONTACT_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical\">Agent on contact time</a> </p> </dd> <dt>SUM_CONTACTS_DISCONNECTED </dt> <dd> <p>Valid metric filter key: <code>DISCONNECT_REASON</code> </p> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical\">Contact disconnected</a> </p> </dd> <dt>SUM_ERROR_STATUS_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#error-status-time-historical\">Error status time</a> </p> </dd> <dt>SUM_HANDLE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-handle-time-historical\">Contact handle time</a> </p> </dd> <dt>SUM_HOLD_TIME</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#customer-hold-time-historical\">Customer hold time</a> </p> </dd> <dt>SUM_IDLE_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-idle-time-historica\">Agent idle time</a> </p> </dd> <dt>SUM_INTERACTION_AND_HOLD_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-hold-time-historical\">Agent interaction and hold time</a> </p> </dd> <dt>SUM_INTERACTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-time-historical\">Agent interaction time</a> </p> </dd> <dt>SUM_NON_PRODUCTIVE_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#npt-historical\">Non-Productive Time</a> </p> </dd> <dt>SUM_ONLINE_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#online-time-historical\">Online time</a> </p> </dd> <dt>SUM_RETRY_CALLBACK_ATTEMPTS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#callback-attempts-historical\">Callback attempts</a> </p> </dd> </dl>" + "documentation":"<p>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html\">Historical metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <dl> <dt>ABANDONMENT_RATE</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#abandonment-rate-historical\">Abandonment rate</a> </p> </dd> <dt>AGENT_ADHERENT_TIME</dt> <dd> <p>This metric is available only in Amazon Web Services Regions where <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region\">Forecasting, capacity planning, and scheduling</a> is available.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherent-time-historical\">Adherent time</a> </p> </dd> <dt>AGENT_ANSWER_RATE</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-answer-rate-historical\">Agent answer rate</a> </p> </dd> <dt>AGENT_NON_ADHERENT_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#non-adherent-time\">Non-adherent time</a> </p> </dd> <dt>AGENT_NON_RESPONSE</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-non-response\">Agent non-response</a> </p> </dd> <dt>AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>Data for this metric is available starting from October 1, 2023 0:00:00 GMT.</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-nonresponse-no-abandon-historical\">Agent non-response without customer abandons</a> </p> </dd> <dt>AGENT_OCCUPANCY</dt> <dd> <p>Unit: Percentage</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#occupancy-historical\">Occupancy</a> </p> </dd> <dt>AGENT_SCHEDULE_ADHERENCE</dt> <dd> <p>This metric is available only in Amazon Web Services Regions where <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region\">Forecasting, capacity planning, and scheduling</a> is available.</p> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherence-historical\">Adherence</a> </p> </dd> <dt>AGENT_SCHEDULED_TIME</dt> <dd> <p>This metric is available only in Amazon Web Services Regions where <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region\">Forecasting, capacity planning, and scheduling</a> is available.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#scheduled-time-historical\">Scheduled time</a> </p> </dd> <dt>AVG_ABANDON_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-abandon-time-historical\">Average queue abandon time</a> </p> </dd> <dt>AVG_ACTIVE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-active-time-historical\">Average active time</a> </p> </dd> <dt>AVG_AFTER_CONTACT_WORK_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-acw-time-historical\">Average after contact work time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_AGENT_CONNECTING_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code>. For now, this metric only supports the following as <code>INITIATION_METHOD</code>: <code>INBOUND</code> | <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-avg-agent-api-connecting-time\">Average agent API connecting time</a> </p> <note> <p>The <code>Negate</code> key in metric-level filters is not applicable for this metric.</p> </note> </dd> <dt>AVG_AGENT_PAUSE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-pause-time-historical\">Average agent pause time</a> </p> </dd> <dt>AVG_BOT_CONVERSATION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-time-metric\">Average bot conversation time</a> </p> </dd> <dt>AVG_BOT_CONVERSATION_TURNS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-turns-metric\">Average bot conversation turns</a> </p> </dd> <dt>AVG_CASE_RELATED_CONTACTS</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contacts-case-historical\">Average contacts per case</a> </p> </dd> <dt>AVG_CASE_RESOLUTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-case-resolution-time-historical\">Average case resolution time</a> </p> </dd> <dt>AVG_CONTACT_DURATION</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contact-duration-historical\">Average contact duration</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_CONVERSATION_DURATION</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical\">Average conversation duration</a> </p> </dd> <dt>AVG_DIALS_PER_MINUTE</dt> <dd> <p>This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Campaign, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-dials-historical\">Average dials per minute</a> </p> </dd> <dt>AVG_EVALUATION_SCORE</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-evaluation-score-historical\">Average agent evaluation score</a> </p> </dd> <dt>AVG_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-flow-time-historical\">Average flow time</a> </p> </dd> <dt>AVG_GREETING_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-greeting-time-agent-historical\">Average agent greeting time</a> </p> </dd> <dt>AVG_HANDLE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-handle-time-historical\">Average handle time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_HOLD_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-customer-hold-time-historical\">Average customer hold time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_HOLD_TIME_ALL_CONTACTS</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#avg-customer-hold-time-all-contacts-historical\">Average customer hold time all contacts</a> </p> </dd> <dt>AVG_HOLDS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-holds-historical\">Average holds</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_INTERACTION_AND_HOLD_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-customer-hold-time-historical\">Average agent interaction and customer hold time</a> </p> </dd> <dt>AVG_INTERACTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-time-historical\">Average agent interaction time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_INTERRUPTIONS_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-agent-historical\">Average agent interruptions</a> </p> </dd> <dt>AVG_INTERRUPTION_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-time-agent-historical\">Average agent interruption time</a> </p> </dd> <dt>AVG_NON_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##average-non-talk-time-historical\">Average non-talk time</a> </p> </dd> <dt>AVG_QUEUE_ANSWER_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-answer-time-historical\">Average queue answer time</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>AVG_RESOLUTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-resolution-time-historical\">Average resolution time</a> </p> </dd> <dt>AVG_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-historical\">Average talk time</a> </p> </dd> <dt>AVG_TALK_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical\">Average agent talk time</a> </p> </dd> <dt>AVG_TALK_TIME_CUSTOMER</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical\">Average customer talk time</a> </p> </dd> <dt>AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION</dt> <dd> <p>This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Seconds</p> <p>Valid groupings and filters: Campaign</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-wait-time-historical\">Average wait time after customer connection</a> </p> </dd> <dt>AVG_WEIGHTED_EVALUATION_SCORE</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-weighted-agent-evaluation-score-historical\">Average weighted agent evaluation score</a> </p> </dd> <dt>BOT_CONVERSATIONS_COMPLETED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric\">Bot conversations</a> </p> </dd> <dt>BOT_INTENTS_COMPLETED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric\">Bot intents completed</a> </p> </dd> <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X</dt> <dd> <p>This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Campaign</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>GT</code> (for <i>Greater than</i>).</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-historical\">Campaign contacts abandoned after X</a> </p> </dd> <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE</dt> <dd> <p>This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.</p> <p>Unit: Percent</p> <p>Valid groupings and filters: Agent, Campaign</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>GT</code> (for <i>Greater than</i>).</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-rate-historical\">Campaign contacts abandoned after X rate</a> </p> </dd> <dt>CAMPAIGN_INTERACTIONS</dt> <dd> <p>This metric is available only for outbound campaigns using the email delivery mode. </p> <p>Unit: Count</p> <p>Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE</p> <p>Valid groupings and filters: Campaign</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-interactions-historical\">Campaign interactions</a> </p> </dd> <dt>CAMPAIGN_SEND_ATTEMPTS</dt> <dd> <p>This metric is available only for outbound campaigns.</p> <p>Unit: Count</p> <p>Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype </p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-send-attempts-historical\">Campaign send attempts</a> </p> </dd> <dt>CASES_CREATED</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-created-historical\">Cases created</a> </p> </dd> <dt>CONTACTS_CREATED</dt> <dd> <p>Unit: Count</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical\">Contacts created</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>CONTACTS_HANDLED</dt> <dd> <p>Unit: Count</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical\">API contacts handled</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT</dt> <dd> <p>Unit: Count</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code> </p> <p>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical\">Contacts handled (connected to agent timestamp)</a> </p> </dd> <dt>CONTACTS_HOLD_ABANDONS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical\">Contacts hold disconnect</a> </p> </dd> <dt>CONTACTS_ON_HOLD_AGENT_DISCONNECT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical\">Contacts hold agent disconnect</a> </p> </dd> <dt>CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical\">Contacts hold customer disconnect</a> </p> </dd> <dt>CONTACTS_PUT_ON_HOLD</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical\">Contacts put on hold</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_EXTERNAL</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical\">Contacts transferred out external</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_INTERNAL</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical\">Contacts transferred out internal</a> </p> </dd> <dt>CONTACTS_QUEUED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical\">Contacts queued</a> </p> </dd> <dt>CONTACTS_QUEUED_BY_ENQUEUE</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical\">Contacts queued (enqueue timestamp)</a> </p> </dd> <dt>CONTACTS_REMOVED_FROM_QUEUE_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-removed-historical\">Contacts removed from queue in X seconds</a> </p> </dd> <dt>CONTACTS_RESOLVED_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical\">Contacts resolved in X</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical\">Contacts transferred out</a> </p> <note> <p>Feature is a valid filter but not a valid grouping.</p> </note> </dd> <dt>CONTACTS_TRANSFERRED_OUT_BY_AGENT</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical\">Contacts transferred out by agent</a> </p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical\">Contacts transferred out queue</a> </p> </dd> <dt>CURRENT_CASES</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical\">Current cases</a> </p> </dd> <dt>DELIVERY_ATTEMPTS</dt> <dd> <p>This metric is available only for outbound campaigns.</p> <p>Unit: Count</p> <p>Valid metric filter key: <code>ANSWERING_MACHINE_DETECTION_STATUS</code>, <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code>, <code>DISCONNECT_REASON</code> </p> <p>Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempts-historical\">Delivery attempts</a> </p> <note> <p>Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes. </p> </note> </dd> <dt>DELIVERY_ATTEMPT_DISPOSITION_RATE</dt> <dd> <p>This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.</p> <p>Unit: Percent</p> <p>Valid metric filter key: <code>ANSWERING_MACHINE_DETECTION_STATUS</code>, <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code>, <code>DISCONNECT_REASON</code> </p> <p>Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempt-disposition-rate-historical\">Delivery attempt disposition rate</a> </p> <note> <p>Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes. </p> </note> </dd> <dt>EVALUATIONS_PERFORMED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#evaluations-performed-historical\">Evaluations performed</a> </p> </dd> <dt>FLOWS_OUTCOME</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical\">Flows outcome</a> </p> </dd> <dt>FLOWS_STARTED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical\">Flows started</a> </p> </dd> <dt>HUMAN_ANSWERED_CALLS</dt> <dd> <p>This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled. </p> <p>Unit: Count</p> <p>Valid groupings and filters: Agent, Campaign</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#human-answered-historical\">Human answered</a> </p> </dd> <dt>MAX_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical\">Maximum flow time</a> </p> </dd> <dt>MAX_QUEUED_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical\">Maximum queued time</a> </p> </dd> <dt>MIN_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical\">Minimum flow time</a> </p> </dd> <dt>PERCENT_AUTOMATIC_FAILS</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#percent-evaluation-automatic-failures-historical\">Automatic fails percent</a> </p> </dd> <dt>PERCENT_BOT_CONVERSATIONS_OUTCOME</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-conversations-outcome-metric\">Percent bot conversations outcome</a> </p> </dd> <dt>PERCENT_BOT_INTENTS_OUTCOME</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome-metric\">Percent bot intents outcome</a> </p> </dd> <dt>PERCENT_CASES_FIRST_CONTACT_RESOLVED</dt> <dd> <p>Unit: Percent</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical\">Cases resolved on first contact</a> </p> </dd> <dt>PERCENT_CONTACTS_STEP_EXPIRED</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, RoutingStepExpression</p> <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</p> </dd> <dt>PERCENT_CONTACTS_STEP_JOINED</dt> <dd> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, RoutingStepExpression</p> <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</p> </dd> <dt>PERCENT_FLOWS_OUTCOME</dt> <dd> <p>Unit: Percent</p> <p>Valid metric filter key: <code>FLOWS_OUTCOME_TYPE</code> </p> <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical\">Flows outcome percentage</a>.</p> <note> <p>The <code>FLOWS_OUTCOME_TYPE</code> is not a valid grouping.</p> </note> </dd> <dt>PERCENT_NON_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical\">Non-talk time percent</a> </p> </dd> <dt>PERCENT_TALK_TIME</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical\">Talk time percent</a> </p> </dd> <dt>PERCENT_TALK_TIME_AGENT</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical\">Agent talk time percent</a> </p> </dd> <dt>PERCENT_TALK_TIME_CUSTOMER</dt> <dd> <p>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</p> <p>Unit: Percentage</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical\">Customer talk time percent</a> </p> </dd> <dt>REOPENED_CASE_ACTIONS</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical\">Cases reopened</a> </p> </dd> <dt>RESOLVED_CASE_ACTIONS</dt> <dd> <p>Unit: Count</p> <p>Required filter key: CASE_TEMPLATE_ARN</p> <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historical\">Cases resolved</a> </p> </dd> <dt>SERVICE_LEVEL</dt> <dd> <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p> <p>Unit: Percent</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical\">Service level X</a> </p> </dd> <dt>STEP_CONTACTS_QUEUED</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, RoutingStepExpression</p> <p>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</p> </dd> <dt>SUM_AFTER_CONTACT_WORK_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical\">After contact work time</a> </p> </dd> <dt>SUM_CONNECTING_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid metric filter key: <code>INITIATION_METHOD</code>. This metric only supports the following filter keys as <code>INITIATION_METHOD</code>: <code>INBOUND</code> | <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code> </p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time\">Agent API connecting time</a> </p> <note> <p>The <code>Negate</code> key in metric-level filters is not applicable for this metric.</p> </note> </dd> <dt>CONTACTS_ABANDONED</dt> <dd> <p>Unit: Count</p> <p>Metric filter: </p> <ul> <li> <p>Valid values: <code>API</code>| <code>Incoming</code> | <code>Outbound</code> | <code>Transfer</code> | <code>Callback</code> | <code>Queue_Transfer</code>| <code>Disconnect</code> </p> </li> </ul> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical\">Contact abandoned</a> </p> </dd> <dt>SUM_CONTACTS_ABANDONED_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical\">Contacts abandoned in X seconds</a> </p> </dd> <dt>SUM_CONTACTS_ANSWERED_IN_X</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for \"Less than\") or <code>LTE</code> (for \"Less than equal\").</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical\">Contacts answered in X seconds</a> </p> </dd> <dt>SUM_CONTACT_FLOW_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical\">Contact flow time</a> </p> </dd> <dt>SUM_CONTACT_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical\">Agent on contact time</a> </p> </dd> <dt>SUM_CONTACTS_DISCONNECTED </dt> <dd> <p>Valid metric filter key: <code>DISCONNECT_REASON</code> </p> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical\">Contact disconnected</a> </p> </dd> <dt>SUM_ERROR_STATUS_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#error-status-time-historical\">Error status time</a> </p> </dd> <dt>SUM_HANDLE_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-handle-time-historical\">Contact handle time</a> </p> </dd> <dt>SUM_HOLD_TIME</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#customer-hold-time-historical\">Customer hold time</a> </p> </dd> <dt>SUM_IDLE_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-idle-time-historica\">Agent idle time</a> </p> </dd> <dt>SUM_INTERACTION_AND_HOLD_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-hold-time-historical\">Agent interaction and hold time</a> </p> </dd> <dt>SUM_INTERACTION_TIME</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-time-historical\">Agent interaction time</a> </p> </dd> <dt>SUM_NON_PRODUCTIVE_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#npt-historical\">Non-Productive Time</a> </p> </dd> <dt>SUM_ONLINE_TIME_AGENT</dt> <dd> <p>Unit: Seconds</p> <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#online-time-historical\">Online time</a> </p> </dd> <dt>SUM_RETRY_CALLBACK_ATTEMPTS</dt> <dd> <p>Unit: Count</p> <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</p> <p>UI name: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#callback-attempts-historical\">Callback attempts</a> </p> </dd> </dl>" }, "NextToken":{ "shape":"NextToken2500", @@ -15084,6 +15257,43 @@ } } }, + "ListAnalyticsDataLakeDataSetsRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>", + "location":"uri", + "locationName":"InstanceId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"<p>The maximum number of results to return per page.</p>", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListAnalyticsDataLakeDataSetsResponse":{ + "type":"structure", + "members":{ + "Results":{ + "shape":"AnalyticsDataSetsResults", + "documentation":"<p>An array of successful results: <code>DataSetId</code>, <code>DataSetName</code>. This is a paginated API, so <code>nextToken</code> is given if there are more results to be returned.</p>" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"<p>If there are additional results, this is the token for the next set of results.</p>" + } + } + }, "ListApprovedOriginsRequest":{ "type":"structure", "required":["InstanceId"], @@ -17575,7 +17785,7 @@ }, "UserIds":{ "shape":"UserIdList", - "documentation":"<p>A list of user IDs.</p>" + "documentation":"<p>A list of user IDs. Supports variable injection of <code>$.ContactLens.ContactEvaluation.Agent.AgentId</code> for <code>OnContactEvaluationSubmit</code> event source. </p>" } }, "documentation":"<p>The type of notification recipient.</p>" @@ -21240,7 +21450,7 @@ }, "ResourceTypes":{ "shape":"ResourceTypeList", - "documentation":"<p>The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.</p> <p class=\"title\"> <b>Supported resource types</b> </p> <ul> <li> <p>AGENT</p> </li> <li> <p>ROUTING_PROFILE</p> </li> <li> <p>STANDARD_QUEUE</p> </li> <li> <p>SECURITY_PROFILE</p> </li> <li> <p>OPERATING_HOURS</p> </li> <li> <p>PROMPT</p> </li> <li> <p>CONTACT_FLOW</p> </li> <li> <p>FLOW_MODULE</p> </li> </ul>" + "documentation":"<p>The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types. Note that lowercase and - are required.</p> <p class=\"title\"> <b>Supported resource types</b> </p> <ul> <li> <p>agent</p> </li> <li> <p>agent-state</p> </li> <li> <p>routing-profile</p> </li> <li> <p>standard-queue</p> </li> <li> <p>security-profile</p> </li> <li> <p>operating-hours</p> </li> <li> <p>prompt</p> </li> <li> <p>contact-flow</p> </li> <li> <p>flow- module</p> </li> <li> <p>transfer-destination (also known as quick connect)</p> </li> </ul>" }, "NextToken":{ "shape":"NextToken2500", @@ -21419,7 +21629,7 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p> <note> <p>InstanceID is a required field. The \"Required: No\" below is incorrect.</p> </note>" + "documentation":"<p>The identifier of the Amazon Connect instance. You can <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html\">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>" }, "NextToken":{ "shape":"NextToken2500", @@ -24044,7 +24254,7 @@ }, "Attributes":{ "shape":"Attributes", - "documentation":"<p>The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.</p> <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p> <p>When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:</p> <ul> <li> <p>Remove unnecessary attributes by setting their values to empty.</p> </li> <li> <p>If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html\">Flow block: Set contact attributes</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </li> </ul>" + "documentation":"<p>The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.</p> <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</p> <p>In the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html\">Set contact attributes</a> block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:</p> <ul> <li> <p>Remove unnecessary attributes by setting their values to empty.</p> </li> <li> <p>If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html\">Flow block: Set contact attributes</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </li> </ul>" } } }, @@ -24622,13 +24832,18 @@ }, "AttributeType":{ "shape":"InstanceAttributeType", - "documentation":"<p>The type of attribute.</p> <note> <p>Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.</p> </note>", + "documentation":"<p>The type of attribute.</p> <note> <p>Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web ServicesSupport for allowlisting.</p> </note>", "location":"uri", "locationName":"AttributeType" }, "Value":{ "shape":"InstanceAttributeValue", "documentation":"<p>The value for the attribute. Maximum character limit is 100. </p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true } } }, @@ -24659,7 +24874,12 @@ "location":"querystring", "locationName":"resourceType" }, - "StorageConfig":{"shape":"InstanceStorageConfig"} + "StorageConfig":{"shape":"InstanceStorageConfig"}, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>", + "idempotencyToken":true + } } }, "UpdateParticipantAuthenticationRequest":{ diff --git a/contrib/python/botocore/py3/botocore/data/connectcases/2022-10-03/paginators-1.json b/contrib/python/botocore/py3/botocore/data/connectcases/2022-10-03/paginators-1.json index 6ce244da4fa..a0317075478 100644 --- a/contrib/python/botocore/py3/botocore/data/connectcases/2022-10-03/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/connectcases/2022-10-03/paginators-1.json @@ -11,6 +11,12 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "relatedItems" + }, + "ListCaseRules": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "caseRules" } } } diff --git a/contrib/python/botocore/py3/botocore/data/connectcases/2022-10-03/service-2.json b/contrib/python/botocore/py3/botocore/data/connectcases/2022-10-03/service-2.json index 5974e1856d2..4d661360c30 100644 --- a/contrib/python/botocore/py3/botocore/data/connectcases/2022-10-03/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/connectcases/2022-10-03/service-2.json @@ -13,6 +13,24 @@ "uid":"connectcases-2022-10-03" }, "operations":{ + "BatchGetCaseRule":{ + "name":"BatchGetCaseRule", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/rules-batch", + "responseCode":200 + }, + "input":{"shape":"BatchGetCaseRuleRequest"}, + "output":{"shape":"BatchGetCaseRuleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"<p>Gets a batch of case rules. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>" + }, "BatchGetField":{ "name":"BatchGetField", "http":{ @@ -68,7 +86,28 @@ {"shape":"AccessDeniedException"}, {"shape":"ConflictException"} ], - "documentation":"<note> <p>If you provide a value for <code>PerformedBy.UserArn</code> you must also have <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <pre><code> <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> </code></pre>", + "documentation":"<note> <p>If you provide a value for <code>PerformedBy.UserArn</code> you must also have <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <pre><code> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> </code></pre>", + "idempotent":true + }, + "CreateCaseRule":{ + "name":"CreateCaseRule", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/case-rules", + "responseCode":200 + }, + "input":{"shape":"CreateCaseRuleRequest"}, + "output":{"shape":"CreateCaseRuleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"<p>Creates a new case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>", "idempotent":true }, "CreateDomain":{ @@ -149,7 +188,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Creates a related item (comments, tasks, and contacts) and associates it with a case.</p> <note> <ul> <li> <p>A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a <code>contactArn</code>). All Related Items have their own internal identifier, the <code>relatedItemArn</code>. Examples of related items include <code>comments</code> and <code>contacts</code>.</p> </li> <li> <p>If you provide a value for <code>performedBy.userArn</code> you must also have <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html\">DescribeUser</a> permission on the ARN of the user that you provide.</p> </li> </ul> <pre><code> </note> </code></pre>", + "documentation":"<p>Creates a related item (comments, tasks, and contacts) and associates it with a case.</p> <note> <ul> <li> <p>A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a <code>contactArn</code>). All Related Items have their own internal identifier, the <code>relatedItemArn</code>. Examples of related items include <code>comments</code> and <code>contacts</code>.</p> </li> <li> <p>If you provide a value for <code>performedBy.userArn</code> you must also have <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html\">DescribeUser</a> permission on the ARN of the user that you provide.</p> </li> <li> <p>The <code>type</code> field is reserved for internal use only.</p> </li> </ul> </note>", "idempotent":true }, "CreateTemplate":{ @@ -170,7 +209,26 @@ {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.</p>", + "documentation":"<p>Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.</p> <p> Other template APIs are: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html\">DeleteTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html\">GetTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html\">ListTemplates</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html\">UpdateTemplate</a> </p> </li> </ul>", + "idempotent":true + }, + "DeleteCaseRule":{ + "name":"DeleteCaseRule", + "http":{ + "method":"DELETE", + "requestUri":"/domains/{domainId}/case-rules/{caseRuleId}", + "responseCode":200 + }, + "input":{"shape":"DeleteCaseRuleRequest"}, + "output":{"shape":"DeleteCaseRuleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"<p>Deletes a case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>", "idempotent":true }, "DeleteDomain":{ @@ -360,7 +418,25 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Returns the details for the requested template. </p>" + "documentation":"<p>Returns the details for the requested template. Other template APIs are: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html\">CreateTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html\">DeleteTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html\">ListTemplates</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html\">UpdateTemplate</a> </p> </li> </ul>" + }, + "ListCaseRules":{ + "name":"ListCaseRules", + "http":{ + "method":"POST", + "requestUri":"/domains/{domainId}/rules-list/", + "responseCode":200 + }, + "input":{"shape":"ListCaseRulesRequest"}, + "output":{"shape":"ListCaseRulesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"<p>Lists all case rules in a Cases domain. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>" }, "ListCasesForContact":{ "name":"ListCasesForContact", @@ -486,7 +562,7 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. </p>" + "documentation":"<p>Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. </p> <p> Other template APIs are: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html\">CreateTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html\">DeleteTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html\">GetTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html\">UpdateTemplate</a> </p> </li> </ul>" }, "PutCaseEventConfiguration":{ "name":"PutCaseEventConfiguration", @@ -594,7 +670,27 @@ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<note> <p>If you provide a value for <code>PerformedBy.UserArn</code> you must also have <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <pre><code> <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p> </code></pre>" + "documentation":"<note> <p>If you provide a value for <code>PerformedBy.UserArn</code> you must also have <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html\">connect:DescribeUser</a> permission on the User ARN resource that you provide</p> </note> <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>" + }, + "UpdateCaseRule":{ + "name":"UpdateCaseRule", + "http":{ + "method":"PUT", + "requestUri":"/domains/{domainId}/case-rules/{caseRuleId}", + "responseCode":200 + }, + "input":{"shape":"UpdateCaseRuleRequest"}, + "output":{"shape":"UpdateCaseRuleResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"<p>Updates a case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>", + "idempotent":true }, "UpdateField":{ "name":"UpdateField", @@ -654,7 +750,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ConflictException"} ], - "documentation":"<p>Updates the attributes of an existing template. The template attributes that can be modified include <code>name</code>, <code>description</code>, <code>layoutConfiguration</code>, <code>requiredFields</code>, and <code>status</code>. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.</p>", + "documentation":"<p>Updates the attributes of an existing template. The template attributes that can be modified include <code>name</code>, <code>description</code>, <code>layoutConfiguration</code>, <code>requiredFields</code>, and <code>status</code>. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.</p> <p>Other template APIs are:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html\">CreateTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html\">DeleteTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html\">GetTemplate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html\">ListTemplates</a> </p> </li> </ul>", "idempotent":true } }, @@ -820,6 +916,54 @@ }, "documentation":"<p>Content specific to <code>BasicLayout</code> type. It configures fields in the top panel and More Info tab of agent application. </p>" }, + "BatchGetCaseRuleRequest":{ + "type":"structure", + "required":[ + "caseRules", + "domainId" + ], + "members":{ + "caseRules":{ + "shape":"CaseRuleIdentifierList", + "documentation":"<p>List of case rule identifiers.</p>" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"<p>Unique identifier of a Cases domain.</p>", + "location":"uri", + "locationName":"domainId" + } + } + }, + "BatchGetCaseRuleResponse":{ + "type":"structure", + "required":[ + "caseRules", + "errors" + ], + "members":{ + "caseRules":{ + "shape":"BatchGetCaseRuleResponseCaseRulesList", + "documentation":"<p>List of detailed case rule information.</p>" + }, + "errors":{ + "shape":"BatchGetCaseRuleResponseErrorsList", + "documentation":"<p>List of case rule errors.</p>" + } + } + }, + "BatchGetCaseRuleResponseCaseRulesList":{ + "type":"list", + "member":{"shape":"GetCaseRuleResponse"}, + "max":50, + "min":0 + }, + "BatchGetCaseRuleResponseErrorsList":{ + "type":"list", + "member":{"shape":"CaseRuleError"}, + "max":50, + "min":0 + }, "BatchGetFieldIdentifierList":{ "type":"list", "member":{"shape":"FieldIdentifier"}, @@ -925,6 +1069,50 @@ "type":"boolean", "box":true }, + "BooleanCondition":{ + "type":"structure", + "members":{ + "equalTo":{ + "shape":"BooleanOperands", + "documentation":"<p>Tests that operandOne is equal to operandTwo.</p>" + }, + "notEqualTo":{ + "shape":"BooleanOperands", + "documentation":"<p>Tests that operandOne is not equal to operandTwo.</p>" + } + }, + "documentation":"<p>Boolean condition for a rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>", + "union":true + }, + "BooleanConditionList":{ + "type":"list", + "member":{"shape":"BooleanCondition"}, + "max":100, + "min":0 + }, + "BooleanOperands":{ + "type":"structure", + "required":[ + "operandOne", + "operandTwo", + "result" + ], + "members":{ + "operandOne":{ + "shape":"OperandOne", + "documentation":"<p>Represents the left hand operand in the condition.</p>" + }, + "operandTwo":{ + "shape":"OperandTwo", + "documentation":"<p>Represents the right hand operand in the condition.</p>" + }, + "result":{ + "shape":"Boolean", + "documentation":"<p>The value of the outer rule if the condition evaluates to true.</p>" + } + }, + "documentation":"<p>Boolean operands for a condition. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>" + }, "CaseArn":{ "type":"string", "max":500, @@ -984,6 +1172,109 @@ "max":500, "min":1 }, + "CaseRuleArn":{ + "type":"string", + "max":500, + "min":1 + }, + "CaseRuleDescription":{ + "type":"string", + "max":255, + "min":0 + }, + "CaseRuleDetails":{ + "type":"structure", + "members":{ + "required":{ + "shape":"RequiredCaseRule", + "documentation":"<p>Required rule type, used to indicate whether a field is required.</p>" + } + }, + "documentation":"<p>Represents what rule type should take place, under what conditions. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>", + "union":true + }, + "CaseRuleError":{ + "type":"structure", + "required":[ + "errorCode", + "id" + ], + "members":{ + "errorCode":{ + "shape":"String", + "documentation":"<p>Error code from getting a case rule.</p>" + }, + "id":{ + "shape":"CaseRuleId", + "documentation":"<p>The case rule identifier that caused the error.</p>" + }, + "message":{ + "shape":"String", + "documentation":"<p>Error message from getting a case rule.</p>" + } + }, + "documentation":"<p>Error for batch describe case rules API failure. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>" + }, + "CaseRuleId":{ + "type":"string", + "max":500, + "min":1 + }, + "CaseRuleIdentifier":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"CaseRuleId", + "documentation":"<p>Unique identifier of a case rule.</p>" + } + }, + "documentation":"<p>Object containing case rule identifier information.</p>" + }, + "CaseRuleIdentifierList":{ + "type":"list", + "member":{"shape":"CaseRuleIdentifier"}, + "max":50, + "min":1 + }, + "CaseRuleName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^.*[\\S]$" + }, + "CaseRuleSummary":{ + "type":"structure", + "required":[ + "caseRuleArn", + "caseRuleId", + "name", + "ruleType" + ], + "members":{ + "caseRuleArn":{ + "shape":"CaseRuleArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the case rule. </p>" + }, + "caseRuleId":{ + "shape":"CaseRuleId", + "documentation":"<p>Unique identifier of a case rule.</p>" + }, + "description":{ + "shape":"CaseRuleDescription", + "documentation":"<p>Description of a case rule.</p>" + }, + "name":{ + "shape":"CaseRuleName", + "documentation":"<p>Name of the case rule.</p>" + }, + "ruleType":{ + "shape":"RuleType", + "documentation":"<p>Possible types for a rule.</p>" + } + }, + "documentation":"<p>Summary information of this case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>" + }, "CaseSummary":{ "type":"structure", "required":[ @@ -1009,7 +1300,7 @@ }, "CommentBody":{ "type":"string", - "max":3000, + "max":15000, "min":1 }, "CommentBodyTextType":{ @@ -1174,6 +1465,51 @@ } } }, + "CreateCaseRuleRequest":{ + "type":"structure", + "required":[ + "domainId", + "name", + "rule" + ], + "members":{ + "description":{ + "shape":"CaseRuleDescription", + "documentation":"<p>The description of a case rule.</p>" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"<p>Unique identifier of a Cases domain.</p>", + "location":"uri", + "locationName":"domainId" + }, + "name":{ + "shape":"CaseRuleName", + "documentation":"<p>Name of the case rule.</p>" + }, + "rule":{ + "shape":"CaseRuleDetails", + "documentation":"<p>Represents what rule type should take place, under what conditions.</p>" + } + } + }, + "CreateCaseRuleResponse":{ + "type":"structure", + "required":[ + "caseRuleArn", + "caseRuleId" + ], + "members":{ + "caseRuleArn":{ + "shape":"CaseRuleArn", + "documentation":"<p>The Amazon Resource Name (ARN) of a case rule.</p>" + }, + "caseRuleId":{ + "shape":"CaseRuleId", + "documentation":"<p>Unique identifier of a case rule.</p>" + } + } + }, "CreateDomainRequest":{ "type":"structure", "required":["name"], @@ -1373,6 +1709,10 @@ "shape":"RequiredFieldList", "documentation":"<p>A list of fields that must contain a value for a case to be successfully created with this template.</p>" }, + "rules":{ + "shape":"TemplateCaseRuleList", + "documentation":"<p>A list of case rules (also known as <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">case field conditions</a>) on a template. </p>" + }, "status":{ "shape":"TemplateStatus", "documentation":"<p>The status of the template.</p>" @@ -1400,6 +1740,32 @@ "type":"timestamp", "timestampFormat":"iso8601" }, + "DeleteCaseRuleRequest":{ + "type":"structure", + "required":[ + "caseRuleId", + "domainId" + ], + "members":{ + "caseRuleId":{ + "shape":"CaseRuleId", + "documentation":"<p>Unique identifier of a case rule.</p>", + "location":"uri", + "locationName":"caseRuleId" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"<p>Unique identifier of a Cases domain.</p>", + "location":"uri", + "locationName":"domainId" + } + } + }, + "DeleteCaseRuleResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteDomainRequest":{ "type":"structure", "required":["domainId"], @@ -1557,6 +1923,12 @@ }, "documentation":"<p>An empty value. You cannot set <code>EmptyFieldValue</code> on a field that is required on a case template.</p> <p>This structure will never have any data members. It signifies an empty value on a case field.</p>" }, + "EmptyOperandValue":{ + "type":"structure", + "members":{ + }, + "documentation":"<p>Represents an empty operand value. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>" + }, "EventBridgeConfiguration":{ "type":"structure", "required":["enabled"], @@ -1864,7 +2236,7 @@ "documentation":"<p>Represents the user that performed the audit.</p>" } }, - "documentation":"<p>Object to store union of Field values.</p> <note> <p>The <code>Summary</code> system field accepts 1500 characters while all other fields accept 500 characters.</p> </note>", + "documentation":"<p>Object to store union of Field values.</p> <note> <p>The <code>Summary</code> system field accepts 3000 characters while all other fields accept 500 characters.</p> </note>", "union":true }, "FieldValueUnionStringValueString":{ @@ -2042,6 +2414,54 @@ "max":100, "min":0 }, + "GetCaseRuleResponse":{ + "type":"structure", + "required":[ + "caseRuleArn", + "caseRuleId", + "name", + "rule" + ], + "members":{ + "caseRuleArn":{ + "shape":"CaseRuleArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the case rule.</p>" + }, + "caseRuleId":{ + "shape":"CaseRuleId", + "documentation":"<p>Unique identifier of a case rule.</p>" + }, + "createdTime":{ + "shape":"CreatedTime", + "documentation":"<p>Timestamp when the resource was created.</p>" + }, + "deleted":{ + "shape":"Deleted", + "documentation":"<p>Indicates whether the resource has been deleted.</p>" + }, + "description":{ + "shape":"CaseRuleDescription", + "documentation":"<p>Description of a case rule.</p>" + }, + "lastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"<p>Timestamp when the resource was created or last modified.</p>" + }, + "name":{ + "shape":"CaseRuleName", + "documentation":"<p>Name of the case rule.</p>" + }, + "rule":{ + "shape":"CaseRuleDetails", + "documentation":"<p>Represents what rule type should take place, under what conditions.</p>" + }, + "tags":{ + "shape":"Tags", + "documentation":"<p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>" + } + }, + "documentation":"<p>Detailed case rule information. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>" + }, "GetDomainRequest":{ "type":"structure", "required":["domainId"], @@ -2265,6 +2685,10 @@ "shape":"RequiredFieldList", "documentation":"<p>A list of fields that must contain a value for a case to be successfully created with this template.</p>" }, + "rules":{ + "shape":"TemplateCaseRuleList", + "documentation":"<p>A list of case rules (also known as <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">case field conditions</a>) on a template. </p>" + }, "status":{ "shape":"TemplateStatus", "documentation":"<p>The status of the template.</p>" @@ -2385,6 +2809,50 @@ "type":"list", "member":{"shape":"LayoutSummary"} }, + "ListCaseRulesRequest":{ + "type":"structure", + "required":["domainId"], + "members":{ + "domainId":{ + "shape":"DomainId", + "documentation":"<p>Unique identifier of a Cases domain.</p>", + "location":"uri", + "locationName":"domainId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"<p>The maximum number of results to return per page.</p>", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListCaseRulesResponse":{ + "type":"structure", + "required":["caseRules"], + "members":{ + "caseRules":{ + "shape":"ListCaseRulesResponseCaseRulesList", + "documentation":"<p>A list of field summary objects.</p>" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>The token for the next set of results. This is null if there are no more results to return.</p>" + } + } + }, + "ListCaseRulesResponseCaseRulesList":{ + "type":"list", + "member":{"shape":"CaseRuleSummary"}, + "max":100, + "min":0 + }, "ListCasesForContactRequest":{ "type":"structure", "required":[ @@ -2692,6 +3160,45 @@ "max":9000, "min":0 }, + "OperandOne":{ + "type":"structure", + "members":{ + "fieldId":{ + "shape":"FieldId", + "documentation":"<p>The field ID that this operand should take the value of.</p>" + } + }, + "documentation":"<p>Represents the left hand operand in the condition. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>", + "union":true + }, + "OperandTwo":{ + "type":"structure", + "members":{ + "booleanValue":{ + "shape":"Boolean", + "documentation":"<p>Boolean value type.</p>" + }, + "doubleValue":{ + "shape":"Double", + "documentation":"<p>Double value type.</p>" + }, + "emptyValue":{ + "shape":"EmptyOperandValue", + "documentation":"<p>Empty value type.</p>" + }, + "stringValue":{ + "shape":"OperandTwoStringValueString", + "documentation":"<p>String value type.</p>" + } + }, + "documentation":"<p>Represents the right hand operand in the condition. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>", + "union":true + }, + "OperandTwoStringValueString":{ + "type":"string", + "max":1500, + "min":1 + }, "Order":{ "type":"string", "enum":[ @@ -2809,6 +3316,24 @@ "documentation":"<p>The list of types of related items and their parameters to use for filtering.</p>", "union":true }, + "RequiredCaseRule":{ + "type":"structure", + "required":[ + "conditions", + "defaultValue" + ], + "members":{ + "conditions":{ + "shape":"BooleanConditionList", + "documentation":"<p>List of conditions for the required rule; the first condition to evaluate to true dictates the value of the rule.</p>" + }, + "defaultValue":{ + "shape":"Boolean", + "documentation":"<p>The value of the rule (that is, whether the field is required) should none of the conditions evaluate to true.</p>" + } + }, + "documentation":"<p>Required rule type, used to indicate whether a field is required. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>" + }, "RequiredField":{ "type":"structure", "required":["fieldId"], @@ -2851,6 +3376,10 @@ }, "exception":true }, + "RuleType":{ + "type":"string", + "enum":["Required"] + }, "SearchCasesRequest":{ "type":"structure", "required":["domainId"], @@ -3155,6 +3684,12 @@ "max":500, "min":1 }, + "TemplateCaseRuleList":{ + "type":"list", + "member":{"shape":"TemplateRule"}, + "max":50, + "min":0 + }, "TemplateDescription":{ "type":"string", "max":255, @@ -3171,6 +3706,24 @@ "min":1, "pattern":"^.*[\\S]$" }, + "TemplateRule":{ + "type":"structure", + "required":[ + "caseRuleId", + "fieldId" + ], + "members":{ + "caseRuleId":{ + "shape":"CaseRuleId", + "documentation":"<p>Unique identifier of a case rule.</p>" + }, + "fieldId":{ + "shape":"FieldId", + "documentation":"<p>Unique identifier of a field.</p>" + } + }, + "documentation":"<p>An association representing a case rule acting upon a field. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">Add case field conditions to a case template</a>.</p>" + }, "TemplateStatus":{ "type":"string", "enum":[ @@ -3285,6 +3838,44 @@ "members":{ } }, + "UpdateCaseRuleRequest":{ + "type":"structure", + "required":[ + "caseRuleId", + "domainId" + ], + "members":{ + "caseRuleId":{ + "shape":"CaseRuleId", + "documentation":"<p>Unique identifier of a case rule.</p>", + "location":"uri", + "locationName":"caseRuleId" + }, + "description":{ + "shape":"CaseRuleDescription", + "documentation":"<p>Description of a case rule.</p>" + }, + "domainId":{ + "shape":"DomainId", + "documentation":"<p>Unique identifier of a Cases domain.</p>", + "location":"uri", + "locationName":"domainId" + }, + "name":{ + "shape":"CaseRuleName", + "documentation":"<p>Name of the case rule.</p>" + }, + "rule":{ + "shape":"CaseRuleDetails", + "documentation":"<p>Represents what rule type should take place, under what conditions.</p>" + } + } + }, + "UpdateCaseRuleResponse":{ + "type":"structure", + "members":{ + } + }, "UpdateFieldRequest":{ "type":"structure", "required":[ @@ -3382,6 +3973,10 @@ "shape":"RequiredFieldList", "documentation":"<p>A list of fields that must contain a value for a case to be successfully created with this template.</p>" }, + "rules":{ + "shape":"TemplateCaseRuleList", + "documentation":"<p>A list of case rules (also known as <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html\">case field conditions</a>) on a template.</p>" + }, "status":{ "shape":"TemplateStatus", "documentation":"<p>The status of the template.</p>" @@ -3440,5 +4035,5 @@ "min":0 } }, - "documentation":"<p>With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cases.html\">Amazon Connect Cases</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" + "documentation":"<ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Cases.html\">Cases actions</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Cases.html\">Cases data types</a> </p> </li> </ul> <p>With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/cases.html\">Amazon Connect Cases</a> in the <i>Amazon Connect Administrator Guide</i>.</p>" } diff --git a/contrib/python/botocore/py3/botocore/data/cost-optimization-hub/2022-07-26/service-2.json b/contrib/python/botocore/py3/botocore/data/cost-optimization-hub/2022-07-26/service-2.json index 08c7a9f9469..aca8a9cb4e2 100644 --- a/contrib/python/botocore/py3/botocore/data/cost-optimization-hub/2022-07-26/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/cost-optimization-hub/2022-07-26/service-2.json @@ -184,7 +184,8 @@ "PurchaseSavingsPlans", "PurchaseReservedInstances", "MigrateToGraviton", - "Delete" + "Delete", + "ScaleIn" ] }, "ActionTypeList":{ @@ -193,6 +194,13 @@ "max":100, "min":1 }, + "AllocationStrategy":{ + "type":"string", + "enum":[ + "Prioritized", + "LowestPrice" + ] + }, "BlockStoragePerformanceConfiguration":{ "type":"structure", "members":{ @@ -335,10 +343,29 @@ "members":{ "instance":{ "shape":"InstanceConfiguration", - "documentation":"<p>Details about the instance.</p>" + "documentation":"<p>Details about the instance for the EC2 Auto Scaling group with a single instance type.</p>" + }, + "mixedInstances":{ + "shape":"MixedInstanceConfigurationList", + "documentation":"<p>A list of instance types for an EC2 Auto Scaling group with mixed instance types.</p>" + }, + "type":{ + "shape":"Ec2AutoScalingGroupType", + "documentation":"<p>The type of EC2 Auto Scaling group, showing whether it consists of a single instance type or mixed instance types.</p>" + }, + "allocationStrategy":{ + "shape":"AllocationStrategy", + "documentation":"<p>The strategy used for allocating instances, based on a predefined priority order or based on the lowest available price.</p>" } }, - "documentation":"<p>The EC2 auto scaling group configuration used for recommendations.</p>" + "documentation":"<p>The EC2 Auto Scaling group configuration used for recommendations.</p>" + }, + "Ec2AutoScalingGroupType":{ + "type":"string", + "enum":[ + "SingleInstanceType", + "MixedInstanceTypes" + ] }, "Ec2Instance":{ "type":"structure", @@ -809,10 +836,10 @@ "members":{ "type":{ "shape":"String", - "documentation":"<p>Details about the type.</p>" + "documentation":"<p>The instance type of the configuration.</p>" } }, - "documentation":"<p>The Instance configuration used for recommendations.</p>" + "documentation":"<p>The instance configuration used for recommendations.</p>" }, "Integer":{ "type":"integer", @@ -1005,6 +1032,20 @@ "None" ] }, + "MixedInstanceConfiguration":{ + "type":"structure", + "members":{ + "type":{ + "shape":"String", + "documentation":"<p>The instance type of the configuration.</p>" + } + }, + "documentation":"<p>The configuration for the EC2 Auto Scaling group with mixed instance types.</p>" + }, + "MixedInstanceConfigurationList":{ + "type":"list", + "member":{"shape":"MixedInstanceConfiguration"} + }, "OpenSearchReservedInstances":{ "type":"structure", "members":{ @@ -1542,7 +1583,7 @@ }, "sageMakerSavingsPlans":{ "shape":"SageMakerSavingsPlans", - "documentation":"<p>The SageMaker Savings Plans recommendation details.</p>" + "documentation":"<p>The SageMaker AI Savings Plans recommendation details.</p>" }, "rdsDbInstance":{ "shape":"RdsDbInstance", diff --git a/contrib/python/botocore/py3/botocore/data/datasync/2018-11-09/service-2.json b/contrib/python/botocore/py3/botocore/data/datasync/2018-11-09/service-2.json index 547f6927516..ac83d8d3ca1 100644 --- a/contrib/python/botocore/py3/botocore/data/datasync/2018-11-09/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/datasync/2018-11-09/service-2.json @@ -211,7 +211,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalException"} ], - "documentation":"<p>Creates a transfer <i>location</i> for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.</p> <p>Before you begin, make sure that you understand how DataSync <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb\">accesses SMB file servers</a>.</p>" + "documentation":"<p>Creates a transfer <i>location</i> for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.</p> <p>Before you begin, make sure that you understand how DataSync accesses SMB file servers. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">Providing DataSync access to SMB file servers</a>.</p>" }, "CreateTask":{ "name":"CreateTask", @@ -1679,30 +1679,28 @@ "required":[ "Subdirectory", "ServerHostname", - "User", - "Password", "AgentArns" ], "members":{ "Subdirectory":{ "shape":"SmbSubdirectory", - "documentation":"<p>Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can also mount this path.</p> <p>To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">required permissions</a> for SMB locations.</p>" + "documentation":"<p>Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can also mount this path.</p> <p>To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">Providing DataSync access to SMB file servers</a>.</p>" }, "ServerHostname":{ "shape":"ServerHostname", - "documentation":"<p>Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.</p> <note> <p>You can't specify an IP version 6 (IPv6) address.</p> </note>" + "documentation":"<p>Specifies the domain name or IP address of the SMB file server that your DataSync agent will mount.</p> <p>Remember the following when configuring this parameter:</p> <ul> <li> <p>You can't specify an IP version 6 (IPv6) address.</p> </li> <li> <p>If you're using Kerberos authentication, you must specify a domain name.</p> </li> </ul>" }, "User":{ "shape":"SmbUser", - "documentation":"<p>Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.</p> <p>For information about choosing a user with the right level of access for your transfer, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">required permissions</a> for SMB locations.</p>" + "documentation":"<p>Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p> <p>For information about choosing a user with the right level of access for your transfer, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">Providing DataSync access to SMB file servers</a>.</p>" }, "Domain":{ "shape":"SmbDomain", - "documentation":"<p>Specifies the name of the Active Directory domain that your SMB file server belongs to. </p> <p>If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.</p>" + "documentation":"<p>Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p> <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.</p>" }, "Password":{ "shape":"SmbPassword", - "documentation":"<p>Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">required permissions</a> for SMB locations.</p>" + "documentation":"<p>Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>" }, "AgentArns":{ "shape":"AgentArnList", @@ -1715,6 +1713,26 @@ "Tags":{ "shape":"InputTagList", "documentation":"<p>Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.</p>" + }, + "AuthenticationType":{ + "shape":"SmbAuthenticationType", + "documentation":"<p>Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports <code>NTLM</code> (default) and <code>KERBEROS</code> authentication.</p>" + }, + "DnsIpAddresses":{ + "shape":"DnsIpList", + "documentation":"<p>Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p> <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.</p>" + }, + "KerberosPrincipal":{ + "shape":"KerberosPrincipal", + "documentation":"<p>Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.</p> <p>A Kerberos principal might look like <code>HOST/[email protected]</code>.</p> <p>Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.</p>" + }, + "KerberosKeytab":{ + "shape":"KerberosKeytabFile", + "documentation":"<p>Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.</p> <p>The file must be base64 encoded. If you're using the CLI, the encoding is done for you.</p> <p>To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for <code>KerberosPrincipal</code>. </p>" + }, + "KerberosKrb5Conf":{ + "shape":"KerberosKrb5ConfFile", + "documentation":"<p>Specifies a Kerberos configuration file (<code>krb5.conf</code>) that defines your Kerberos realm configuration.</p> <p>The file must be base64 encoded. If you're using the CLI, the encoding is done for you.</p>" } }, "documentation":"<p>CreateLocationSmbRequest</p>" @@ -2393,19 +2411,31 @@ }, "User":{ "shape":"SmbUser", - "documentation":"<p>The user that can mount and access the files, folders, and file metadata in your SMB file server.</p>" + "documentation":"<p>The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>" }, "Domain":{ "shape":"SmbDomain", - "documentation":"<p>The name of the Microsoft Active Directory domain that the SMB file server belongs to.</p>" + "documentation":"<p>The name of the Windows domain that the SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>" }, "MountOptions":{ "shape":"SmbMountOptions", - "documentation":"<p>The protocol that DataSync use to access your SMB file.</p>" + "documentation":"<p>The SMB protocol version that DataSync uses to access your SMB file server.</p>" }, "CreationTime":{ "shape":"Time", "documentation":"<p>The time that the SMB location was created.</p>" + }, + "DnsIpAddresses":{ + "shape":"DnsIpList", + "documentation":"<p>The IPv4 addresses for the DNS servers that your SMB file server belongs to. This element applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p>" + }, + "KerberosPrincipal":{ + "shape":"KerberosPrincipal", + "documentation":"<p>The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.</p>" + }, + "AuthenticationType":{ + "shape":"SmbAuthenticationType", + "documentation":"<p>The authentication protocol that DataSync uses to connect to your SMB file server.</p>" } }, "documentation":"<p>DescribeLocationSmbResponse</p>" @@ -2867,6 +2897,11 @@ "enum":["NetAppONTAP"] }, "DiscoveryTime":{"type":"timestamp"}, + "DnsIpList":{ + "type":"list", + "member":{"shape":"ServerIpAddress"}, + "max":2 + }, "Duration":{ "type":"long", "min":0 @@ -3074,7 +3109,7 @@ "type":"structure", "members":{ "Domain":{ - "shape":"FsxUpdateSmbDomain", + "shape":"UpdateSmbDomain", "documentation":"<p>Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.</p> <p>If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.</p>" }, "MountOptions":{"shape":"SmbMountOptions"}, @@ -3089,11 +3124,6 @@ }, "documentation":"<p>Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access\">Providing DataSync access to FSx for ONTAP file systems</a>.</p>" }, - "FsxUpdateSmbDomain":{ - "type":"string", - "max":253, - "pattern":"^([A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252})?$" - }, "FsxWindowsSubdirectory":{ "type":"string", "max":4096, @@ -3944,7 +3974,7 @@ "type":"string", "max":63, "min":3, - "pattern":"^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$" + "pattern":"^[a-zA-Z0-9_\\-\\+\\.\\(\\)\\$\\p{Zs}]+$" }, "ObjectStorageCertificate":{ "type":"blob", @@ -4523,6 +4553,19 @@ "max":255, "pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$" }, + "ServerIpAddress":{ + "type":"string", + "max":15, + "min":7, + "pattern":"\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z" + }, + "SmbAuthenticationType":{ + "type":"string", + "enum":[ + "NTLM", + "KERBEROS" + ] + }, "SmbDomain":{ "type":"string", "max":253, @@ -4560,7 +4603,7 @@ "SmbUser":{ "type":"string", "max":104, - "pattern":"^[^\\x5B\\x5D\\\\/:;|=,+*?]{1,104}$" + "pattern":"^[^\\x22\\x5B\\x5D/\\\\:;|=,+*?\\x3C\\x3E]{1,104}$" }, "SmbVersion":{ "type":"string", @@ -5293,7 +5336,7 @@ "documentation":"<p>Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).</p>" }, "Domain":{ - "shape":"FsxUpdateSmbDomain", + "shape":"UpdateSmbDomain", "documentation":"<p>Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.</p> <p>If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.</p>" }, "User":{ @@ -5472,25 +5515,45 @@ }, "Subdirectory":{ "shape":"SmbSubdirectory", - "documentation":"<p>Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can also mount this path.</p> <p>To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">required permissions</a> for SMB locations.</p>" + "documentation":"<p>Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, <code>/path/to/subdirectory</code>). Make sure that other SMB clients in your network can also mount this path.</p> <p>To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">Providing DataSync access to SMB file servers</a>.</p>" }, "User":{ "shape":"SmbUser", - "documentation":"<p>Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.</p> <p>For information about choosing a user with the right level of access for your transfer, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">required permissions</a> for SMB locations.</p>" + "documentation":"<p>Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p> <p>For information about choosing a user with the right level of access for your transfer, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">Providing DataSync access to SMB file servers</a>.</p>" }, "Domain":{ "shape":"SmbDomain", - "documentation":"<p>Specifies the Windows domain name that your SMB file server belongs to. </p> <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">required permissions</a> for SMB locations.</p>" + "documentation":"<p>Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p> <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.</p>" }, "Password":{ "shape":"SmbPassword", - "documentation":"<p>Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions\">required permissions</a> for SMB locations.</p>" + "documentation":"<p>Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if <code>AuthenticationType</code> is set to <code>NTLM</code>.</p>" }, "AgentArns":{ "shape":"AgentArnList", "documentation":"<p>Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).</p>" }, - "MountOptions":{"shape":"SmbMountOptions"} + "MountOptions":{"shape":"SmbMountOptions"}, + "AuthenticationType":{ + "shape":"SmbAuthenticationType", + "documentation":"<p>Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports <code>NTLM</code> (default) and <code>KERBEROS</code> authentication.</p>" + }, + "DnsIpAddresses":{ + "shape":"DnsIpList", + "documentation":"<p>Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if <code>AuthenticationType</code> is set to <code>KERBEROS</code>.</p> <p>If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server. </p>" + }, + "KerberosPrincipal":{ + "shape":"KerberosPrincipal", + "documentation":"<p>Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.</p> <p>A Kerberos principal might look like <code>HOST/[email protected]</code>.</p> <p>Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.</p>" + }, + "KerberosKeytab":{ + "shape":"KerberosKeytabFile", + "documentation":"<p>Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.</p> <p>The file must be base64 encoded. If you're using the CLI, the encoding is done for you.</p> <p>To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for <code>KerberosPrincipal</code>.</p>" + }, + "KerberosKrb5Conf":{ + "shape":"KerberosKrb5ConfFile", + "documentation":"<p>Specifies a Kerberos configuration file (<code>krb5.conf</code>) that defines your Kerberos realm configuration.</p> <p>The file must be base64 encoded. If you're using the CLI, the encoding is done for you.</p>" + } } }, "UpdateLocationSmbResponse":{ @@ -5498,6 +5561,11 @@ "members":{ } }, + "UpdateSmbDomain":{ + "type":"string", + "max":253, + "pattern":"^([A-Za-z0-9]((\\.|-+)?[A-Za-z0-9]){0,252})?$" + }, "UpdateStorageSystemRequest":{ "type":"structure", "required":["StorageSystemArn"], diff --git a/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/paginators-1.json b/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/paginators-1.json index 98dc0959321..0a87c6895d7 100644 --- a/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/paginators-1.json @@ -161,6 +161,18 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "jobParameterDefinitions" + }, + "ListLimits": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "limits" + }, + "ListQueueLimitAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "queueLimitAssociations" } } } diff --git a/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/service-2.json b/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/service-2.json index 12c530990cb..8f26f30931f 100644 --- a/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/service-2.json @@ -312,7 +312,7 @@ {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Creates a job. A job is a set of instructions that AWS Deadline Cloud uses to schedule and run work on available workers. For more information, see <a href=\"https://docs.aws.amazon.com/deadline-cloud/latest/userguide/deadline-cloud-jobs.html\">Deadline Cloud jobs</a>.</p>", + "documentation":"<p>Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see <a href=\"https://docs.aws.amazon.com/deadline-cloud/latest/userguide/deadline-cloud-jobs.html\">Deadline Cloud jobs</a>.</p>", "endpoint":{"hostPrefix":"management."}, "idempotent":true }, @@ -337,6 +337,27 @@ "endpoint":{"hostPrefix":"management."}, "idempotent":true }, + "CreateLimit":{ + "name":"CreateLimit", + "http":{ + "method":"POST", + "requestUri":"/2023-10-12/farms/{farmId}/limits", + "responseCode":200 + }, + "input":{"shape":"CreateLimitRequest"}, + "output":{"shape":"CreateLimitResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"<p>Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues. </p> <p>You must add the <code>amountRequirementName</code> to a step in a job template to declare the limit requirement.</p>", + "endpoint":{"hostPrefix":"management."}, + "idempotent":true + }, "CreateMonitor":{ "name":"CreateMonitor", "http":{ @@ -419,6 +440,26 @@ "endpoint":{"hostPrefix":"management."}, "idempotent":true }, + "CreateQueueLimitAssociation":{ + "name":"CreateQueueLimitAssociation", + "http":{ + "method":"PUT", + "requestUri":"/2023-10-12/farms/{farmId}/queue-limit-associations", + "responseCode":200 + }, + "input":{"shape":"CreateQueueLimitAssociationRequest"}, + "output":{"shape":"CreateQueueLimitAssociationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"<p>Associates a limit with a particular queue. After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same <code>amountRequirementName</code> to the same queue.</p>", + "endpoint":{"hostPrefix":"management."}, + "idempotent":true + }, "CreateStorageProfile":{ "name":"CreateStorageProfile", "http":{ @@ -543,6 +584,25 @@ "endpoint":{"hostPrefix":"management."}, "idempotent":true }, + "DeleteLimit":{ + "name":"DeleteLimit", + "http":{ + "method":"DELETE", + "requestUri":"/2023-10-12/farms/{farmId}/limits/{limitId}", + "responseCode":200 + }, + "input":{"shape":"DeleteLimitRequest"}, + "output":{"shape":"DeleteLimitResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"<p>Removes a limit from the specified farm. Before you delete a limit you must use the <code>DeleteQueueLimitAssociation</code> operation to remove the association with any queues. </p>", + "endpoint":{"hostPrefix":"management."}, + "idempotent":true + }, "DeleteMeteredProduct":{ "name":"DeleteMeteredProduct", "http":{ @@ -644,6 +704,27 @@ "endpoint":{"hostPrefix":"management."}, "idempotent":true }, + "DeleteQueueLimitAssociation":{ + "name":"DeleteQueueLimitAssociation", + "http":{ + "method":"DELETE", + "requestUri":"/2023-10-12/farms/{farmId}/queue-limit-associations/{queueId}/{limitId}", + "responseCode":200 + }, + "input":{"shape":"DeleteQueueLimitAssociationRequest"}, + "output":{"shape":"DeleteQueueLimitAssociationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"} + ], + "documentation":"<p>Removes the association between a queue and a limit. You must use the <code>UpdateQueueLimitAssociation</code> operation to set the status to <code>STOP_LIMIT_USAGE_AND_COMPLETE_TASKS</code> or <code>STOP_LIMIT_USAGE_AND_CANCEL_TASKS</code>. The status does not change immediately. Use the <code>GetQueueLimitAssociation</code> operation to see if the status changed to <code>STOPPED</code> before deleting the association.</p>", + "endpoint":{"hostPrefix":"management."}, + "idempotent":true + }, "DeleteStorageProfile":{ "name":"DeleteStorageProfile", "http":{ @@ -861,6 +942,25 @@ "documentation":"<p>Gets a licence endpoint.</p>", "endpoint":{"hostPrefix":"management."} }, + "GetLimit":{ + "name":"GetLimit", + "http":{ + "method":"GET", + "requestUri":"/2023-10-12/farms/{farmId}/limits/{limitId}", + "responseCode":200 + }, + "input":{"shape":"GetLimitRequest"}, + "output":{"shape":"GetLimitResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"<p>Gets information about a specific limit.</p>", + "endpoint":{"hostPrefix":"management."} + }, "GetMonitor":{ "name":"GetMonitor", "http":{ @@ -937,6 +1037,25 @@ "documentation":"<p>Gets a queue-fleet association.</p>", "endpoint":{"hostPrefix":"management."} }, + "GetQueueLimitAssociation":{ + "name":"GetQueueLimitAssociation", + "http":{ + "method":"GET", + "requestUri":"/2023-10-12/farms/{farmId}/queue-limit-associations/{queueId}/{limitId}", + "responseCode":200 + }, + "input":{"shape":"GetQueueLimitAssociationRequest"}, + "output":{"shape":"GetQueueLimitAssociationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"<p>Gets information about a specific association between a queue and a limit.</p>", + "endpoint":{"hostPrefix":"management."} + }, "GetSession":{ "name":"GetSession", "http":{ @@ -1275,6 +1394,25 @@ "documentation":"<p>Lists license endpoints.</p>", "endpoint":{"hostPrefix":"management."} }, + "ListLimits":{ + "name":"ListLimits", + "http":{ + "method":"GET", + "requestUri":"/2023-10-12/farms/{farmId}/limits", + "responseCode":200 + }, + "input":{"shape":"ListLimitsRequest"}, + "output":{"shape":"ListLimitsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"<p>Gets a list of limits defined in the specified farm.</p>", + "endpoint":{"hostPrefix":"management."} + }, "ListMeteredProducts":{ "name":"ListMeteredProducts", "http":{ @@ -1349,6 +1487,24 @@ "documentation":"<p>Lists queue-fleet associations.</p>", "endpoint":{"hostPrefix":"management."} }, + "ListQueueLimitAssociations":{ + "name":"ListQueueLimitAssociations", + "http":{ + "method":"GET", + "requestUri":"/2023-10-12/farms/{farmId}/queue-limit-associations", + "responseCode":200 + }, + "input":{"shape":"ListQueueLimitAssociationsRequest"}, + "output":{"shape":"ListQueueLimitAssociationsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Gets a list of the associations between queues and limits defined in a farm.</p>", + "endpoint":{"hostPrefix":"management."} + }, "ListQueueMembers":{ "name":"ListQueueMembers", "http":{ @@ -1834,6 +1990,26 @@ "endpoint":{"hostPrefix":"management."}, "idempotent":true }, + "UpdateLimit":{ + "name":"UpdateLimit", + "http":{ + "method":"PATCH", + "requestUri":"/2023-10-12/farms/{farmId}/limits/{limitId}", + "responseCode":200 + }, + "input":{"shape":"UpdateLimitRequest"}, + "output":{"shape":"UpdateLimitResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"<p>Updates the properties of the specified limit. </p>", + "endpoint":{"hostPrefix":"management."}, + "idempotent":true + }, "UpdateMonitor":{ "name":"UpdateMonitor", "http":{ @@ -1913,6 +2089,26 @@ "endpoint":{"hostPrefix":"management."}, "idempotent":true }, + "UpdateQueueLimitAssociation":{ + "name":"UpdateQueueLimitAssociation", + "http":{ + "method":"PATCH", + "requestUri":"/2023-10-12/farms/{farmId}/queue-limit-associations/{queueId}/{limitId}", + "responseCode":200 + }, + "input":{"shape":"UpdateQueueLimitAssociationRequest"}, + "output":{"shape":"UpdateQueueLimitAssociationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"<p>Updates the status of the queue. If you set the status to one of the <code>STOP_LIMIT_USAGE*</code> values, there will be a delay before the status transitions to the <code>STOPPED</code> state. </p>", + "endpoint":{"hostPrefix":"management."}, + "idempotent":true + }, "UpdateSession":{ "name":"UpdateSession", "http":{ @@ -2046,14 +2242,14 @@ "members":{ "selections":{ "shape":"AcceleratorSelections", - "documentation":"<p>A list of objects that contain the GPU name of the accelerator and driver for the instance types that support the accelerator.</p>" + "documentation":"<p>A list of accelerator capabilities requested for this fleet. Only Amazon Elastic Compute Cloud instances that provide these capabilities will be used. For example, if you specify both L4 and T4 chips, Deadline Cloud will use Amazon EC2 instances that have either the L4 or the T4 chip installed.</p>" }, "count":{ "shape":"AcceleratorCountRange", - "documentation":"<p>The number of GPUs on each worker. The default is 1.</p>" + "documentation":"<p>The number of GPU accelerators specified for worker hosts in this fleet. </p>" } }, - "documentation":"<p>Provides information about the GPU accelerators and drivers for the instance types in a fleet. If you include the <code>acceleratorCapabilities</code> property in the <a href=\"https://docs.aws.amazon.com/deadline-cloud/latest/APIReference/API_ServiceManagedEc2InstanceCapabilities\">ServiceManagedEc2InstanceCapabilities</a> object, all of the Amazon EC2 instances will have at least one accelerator. </p>" + "documentation":"<p>Provides information about the GPU accelerators used for jobs processed by a fleet.</p>" }, "AcceleratorCountRange":{ "type":"structure", @@ -2061,14 +2257,14 @@ "members":{ "min":{ "shape":"MinZeroMaxInteger", - "documentation":"<p>The minimum number of GPUs for the accelerator. If you set the value to 0, a worker will still have 1 GPU.</p>" + "documentation":"<p>The minimum number of GPU accelerators in the worker host.</p>" }, "max":{ "shape":"MinZeroMaxInteger", - "documentation":"<p>The maximum number of GPUs for the accelerator.</p>" + "documentation":"<p>The maximum number of GPU accelerators in the worker host.</p>" } }, - "documentation":"<p>The range for the GPU fleet acceleration.</p>" + "documentation":"<p>Defines the maximum and minimum number of GPU accelerators required for a worker instance..</p>" }, "AcceleratorName":{ "type":"string", @@ -2090,14 +2286,14 @@ "members":{ "name":{ "shape":"AcceleratorName", - "documentation":"<p>The name of the GPU accelerator.</p>" + "documentation":"<p>The name of the chip used by the GPU accelerator.</p> <p>If you specify <code>l4</code> as the name of the accelerator, you must specify <code>latest</code> or <code>grid:r550</code> as the runtime.</p> <p>The available GPU accelerators are:</p> <ul> <li> <p> <code>t4</code> - NVIDIA T4 Tensor Core GPU</p> </li> <li> <p> <code>a10g</code> - NVIDIA A10G Tensor Core GPU</p> </li> <li> <p> <code>l4</code> - NVIDIA L4 Tensor Core GPU</p> </li> <li> <p> <code>l40s</code> - NVIDIA L40S Tensor Core GPU</p> </li> </ul>" }, "runtime":{ "shape":"AcceleratorRuntime", - "documentation":"<p>The driver version that the GPU accelerator uses. </p>" + "documentation":"<p>Specifies the runtime driver to use for the GPU accelerator. You must use the same runtime for all GPUs. </p> <p>You can choose from the following runtimes:</p> <ul> <li> <p> <code>latest</code> - Use the latest runtime available for the chip. If you specify <code>latest</code> and a new version of the runtime is released, the new version of the runtime is used.</p> </li> <li> <p> <code>grid:r550</code> - <a href=\"https://docs.nvidia.com/vgpu/17.0/index.html\">NVIDIA vGPU software 17</a> </p> </li> <li> <p> <code>grid:r535</code> - <a href=\"https://docs.nvidia.com/vgpu/16.0/index.html\">NVIDIA vGPU software 16</a> </p> </li> </ul> <p>If you don't specify a runtime, Deadline Cloud uses <code>latest</code> as the default. However, if you have multiple accelerators and specify <code>latest</code> for some and leave others blank, Deadline Cloud raises an exception.</p>" } }, - "documentation":"<p>Values that you can use to select a particular Amazon EC2 instance type. </p>" + "documentation":"<p>Describes a specific GPU accelerator required for an Amazon Elastic Compute Cloud worker host.</p>" }, "AcceleratorSelections":{ "type":"list", @@ -2116,7 +2312,7 @@ "documentation":"<p>The maximum amount of memory to use for the accelerator, measured in MiB.</p>" } }, - "documentation":"<p>The range for memory, in MiB, to use for the accelerator.</p>" + "documentation":"<p>Defines the maximum and minimum amount of memory, in MiB, to use for the accelerator.</p>" }, "AcceleratorType":{ "type":"string", @@ -2147,6 +2343,28 @@ "type":"string", "sensitive":true }, + "AcquiredLimit":{ + "type":"structure", + "required":[ + "limitId", + "count" + ], + "members":{ + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit.</p>" + }, + "count":{ + "shape":"MinOneMaxInteger", + "documentation":"<p>The number of limit resources used.</p>" + } + }, + "documentation":"<p>Provides information about the number of resources used.</p>" + }, + "AcquiredLimits":{ + "type":"list", + "member":{"shape":"AcquiredLimit"} + }, "AggregationId":{ "type":"string", "pattern":"[0-9a-f]{32}" @@ -2163,6 +2381,11 @@ "min":1, "pattern":"([a-zA-Z][a-zA-Z0-9]{0,63}:)?amount(\\.[a-zA-Z][a-zA-Z0-9]{0,63})+" }, + "AmountRequirementName":{ + "type":"string", + "max":1024, + "min":0 + }, "AssignedEnvironmentEnterSessionActionDefinition":{ "type":"structure", "required":["environmentId"], @@ -3328,6 +3551,10 @@ "shape":"MaxRetriesPerTask", "documentation":"<p>The maximum number of retries for each task.</p>" }, + "maxWorkerCount":{ + "shape":"MaxWorkerCount", + "documentation":"<p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.</p> <p>If you don't specify the <code>maxWorkerCount</code>, Deadline Cloud won't throttle the number of workers used to process the job.</p>" + }, "sourceJobId":{ "shape":"JobId", "documentation":"<p>The job ID for the source job.</p>" @@ -3406,6 +3633,56 @@ } } }, + "CreateLimitRequest":{ + "type":"structure", + "required":[ + "displayName", + "amountRequirementName", + "maxCount", + "farmId" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>The unique token which the server uses to recognize retries of the same request.</p>", + "idempotencyToken":true, + "location":"header", + "locationName":"X-Amz-Client-Token" + }, + "displayName":{ + "shape":"ResourceName", + "documentation":"<p>The display name of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>" + }, + "amountRequirementName":{ + "shape":"AmountRequirementName", + "documentation":"<p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of the <code>hostRequirements</code> in a step of a job template to declare the limit requirement.</p>" + }, + "maxCount":{ + "shape":"MaxCount", + "documentation":"<p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>The <code>maxCount</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>" + }, + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The farm ID of the farm that contains the limit.</p>", + "location":"uri", + "locationName":"farmId" + }, + "description":{ + "shape":"Description", + "documentation":"<p>A description of the limit. A description helps you identify the purpose of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>" + } + } + }, + "CreateLimitResponse":{ + "type":"structure", + "required":["limitId"], + "members":{ + "limitId":{ + "shape":"LimitId", + "documentation":"<p>A unique identifier for the limit. Use this identifier in other operations, such as <code>CreateQueueLimitAssociation</code> and <code>DeleteLimit</code>.</p>" + } + } + }, "CreateMonitorRequest":{ "type":"structure", "required":[ @@ -3539,6 +3816,35 @@ "members":{ } }, + "CreateQueueLimitAssociationRequest":{ + "type":"structure", + "required":[ + "farmId", + "queueId", + "limitId" + ], + "members":{ + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the queue and limit to associate.</p>", + "location":"uri", + "locationName":"farmId" + }, + "queueId":{ + "shape":"QueueId", + "documentation":"<p>The unique identifier of the queue to associate with the limit.</p>" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit to associate with the queue.</p>" + } + } + }, + "CreateQueueLimitAssociationResponse":{ + "type":"structure", + "members":{ + } + }, "CreateQueueRequest":{ "type":"structure", "required":[ @@ -3913,6 +4219,32 @@ "members":{ } }, + "DeleteLimitRequest":{ + "type":"structure", + "required":[ + "farmId", + "limitId" + ], + "members":{ + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the limit to delete.</p>", + "location":"uri", + "locationName":"farmId" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit to delete.</p>", + "location":"uri", + "locationName":"limitId" + } + } + }, + "DeleteLimitResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteMeteredProductRequest":{ "type":"structure", "required":[ @@ -4022,6 +4354,39 @@ "members":{ } }, + "DeleteQueueLimitAssociationRequest":{ + "type":"structure", + "required":[ + "farmId", + "queueId", + "limitId" + ], + "members":{ + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the queue and limit to disassociate.</p>", + "location":"uri", + "locationName":"farmId" + }, + "queueId":{ + "shape":"QueueId", + "documentation":"<p>The unique identifier of the queue to disassociate.</p>", + "location":"uri", + "locationName":"queueId" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit to disassociate.</p>", + "location":"uri", + "locationName":"limitId" + } + } + }, + "DeleteQueueLimitAssociationResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteQueueRequest":{ "type":"structure", "required":[ @@ -4288,10 +4653,7 @@ "members":{ } }, - "DnsName":{ - "type":"string", - "pattern":"vpce-[\\w]+-[\\w]+.vpce-svc-[\\w]+.*.vpce.amazonaws.com" - }, + "DnsName":{"type":"string"}, "Document":{ "type":"structure", "members":{ @@ -5165,8 +5527,8 @@ "type":"structure", "required":[ "farmId", - "jobId", - "queueId" + "queueId", + "jobId" ], "members":{ "farmId":{ @@ -5175,17 +5537,17 @@ "location":"uri", "locationName":"farmId" }, - "jobId":{ - "shape":"JobId", - "documentation":"<p>The job ID.</p>", - "location":"uri", - "locationName":"jobId" - }, "queueId":{ "shape":"QueueId", "documentation":"<p>The queue ID associated with the job.</p>", "location":"uri", "locationName":"queueId" + }, + "jobId":{ + "shape":"JobId", + "documentation":"<p>The job ID.</p>", + "location":"uri", + "locationName":"jobId" } } }, @@ -5281,6 +5643,10 @@ "shape":"JobDescription", "documentation":"<p>The description of the job.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>" }, + "maxWorkerCount":{ + "shape":"MaxWorkerCount", + "documentation":"<p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>If you don't set the <code>maxWorkerCount</code> when you create a job, this value is not returned in the response.</p>" + }, "sourceJobId":{ "shape":"JobId", "documentation":"<p>The job ID for the source job.</p>" @@ -5349,6 +5715,86 @@ "max":10, "min":1 }, + "GetLimitRequest":{ + "type":"structure", + "required":[ + "farmId", + "limitId" + ], + "members":{ + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the limit.</p>", + "location":"uri", + "locationName":"farmId" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit to return.</p>", + "location":"uri", + "locationName":"limitId" + } + } + }, + "GetLimitResponse":{ + "type":"structure", + "required":[ + "displayName", + "amountRequirementName", + "maxCount", + "createdAt", + "createdBy", + "farmId", + "limitId", + "currentCount" + ], + "members":{ + "displayName":{ + "shape":"ResourceName", + "documentation":"<p>The display name of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>" + }, + "amountRequirementName":{ + "shape":"AmountRequirementName", + "documentation":"<p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of the <code>hostRequirements</code> in a step of a job template to declare the limit requirement.</p>" + }, + "maxCount":{ + "shape":"MaxCount", + "documentation":"<p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>The <code>maxValue</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>" + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"<p>The Unix timestamp of the date and time that the limit was created.</p>" + }, + "createdBy":{ + "shape":"CreatedBy", + "documentation":"<p>The user identifier of the person that created the limit.</p>" + }, + "updatedAt":{ + "shape":"UpdatedAt", + "documentation":"<p>The Unix timestamp of the date and time that the limit was last updated.</p>" + }, + "updatedBy":{ + "shape":"UpdatedBy", + "documentation":"<p>The user identifier of the person that last updated the limit.</p>" + }, + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the limit.</p>" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit.</p>" + }, + "currentCount":{ + "shape":"MinZeroMaxInteger", + "documentation":"<p>The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.</p>" + }, + "description":{ + "shape":"Description", + "documentation":"<p>The description of the limit that helps identify what the limit is used for.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>" + } + } + }, "GetMonitorRequest":{ "type":"structure", "required":["monitorId"], @@ -5567,6 +6013,74 @@ } } }, + "GetQueueLimitAssociationRequest":{ + "type":"structure", + "required":[ + "farmId", + "queueId", + "limitId" + ], + "members":{ + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the associated queue and limit.</p>", + "location":"uri", + "locationName":"farmId" + }, + "queueId":{ + "shape":"QueueId", + "documentation":"<p>The unique identifier of the queue associated with the limit.</p>", + "location":"uri", + "locationName":"queueId" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit associated with the queue.</p>", + "location":"uri", + "locationName":"limitId" + } + } + }, + "GetQueueLimitAssociationResponse":{ + "type":"structure", + "required":[ + "createdAt", + "createdBy", + "queueId", + "limitId", + "status" + ], + "members":{ + "createdAt":{ + "shape":"CreatedAt", + "documentation":"<p>The Unix timestamp of the date and time that the association was created.</p>" + }, + "createdBy":{ + "shape":"CreatedBy", + "documentation":"<p>The user identifier of the person that created the association.</p>" + }, + "updatedAt":{ + "shape":"UpdatedAt", + "documentation":"<p>The Unix timestamp of the date and time that the association was last updated.</p>" + }, + "updatedBy":{ + "shape":"UpdatedBy", + "documentation":"<p>The user identifier of the person that last updated the association.</p>" + }, + "queueId":{ + "shape":"QueueId", + "documentation":"<p>The unique identifier of the queue associated with the limit.</p>" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit associated with the queue.</p>" + }, + "status":{ + "shape":"QueueLimitAssociationStatus", + "documentation":"<p>The current status of the limit.</p>" + } + } + }, "GetQueueRequest":{ "type":"structure", "required":[ @@ -5749,6 +6263,10 @@ "definition":{ "shape":"SessionActionDefinition", "documentation":"<p>The session action definition.</p>" + }, + "acquiredLimits":{ + "shape":"AcquiredLimits", + "documentation":"<p>The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.</p>" } } }, @@ -6271,18 +6789,14 @@ "GetWorkerResponse":{ "type":"structure", "required":[ - "workerId", "farmId", "fleetId", + "workerId", "status", "createdAt", "createdBy" ], "members":{ - "workerId":{ - "shape":"WorkerId", - "documentation":"<p>The worker ID.</p>" - }, "farmId":{ "shape":"FarmId", "documentation":"<p>The farm ID.</p>" @@ -6291,6 +6805,10 @@ "shape":"FleetId", "documentation":"<p>The fleet ID.</p>" }, + "workerId":{ + "shape":"WorkerId", + "documentation":"<p>The worker ID.</p>" + }, "hostProperties":{ "shape":"HostPropertiesResponse", "documentation":"<p>The host properties for the worker.</p>" @@ -6878,6 +7396,10 @@ "shape":"JobParameters", "documentation":"<p>The job parameters.</p>" }, + "maxWorkerCount":{ + "shape":"MaxWorkerCount", + "documentation":"<p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.</p> <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p>" + }, "sourceJobId":{ "shape":"JobId", "documentation":"<p>The job ID for the source job.</p>" @@ -6965,6 +7487,10 @@ "shape":"MaxRetriesPerTask", "documentation":"<p>The maximum number of retries for a job.</p>" }, + "maxWorkerCount":{ + "shape":"MaxWorkerCount", + "documentation":"<p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.</p> <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p>" + }, "sourceJobId":{ "shape":"JobId", "documentation":"<p>The job ID for the source job.</p>" @@ -7040,6 +7566,70 @@ "documentation":"<p>The details for a license endpoint.</p>" }, "LicenseProduct":{"type":"string"}, + "LimitId":{ + "type":"string", + "pattern":"limit-[0-9a-f]{32}" + }, + "LimitSummaries":{ + "type":"list", + "member":{"shape":"LimitSummary"} + }, + "LimitSummary":{ + "type":"structure", + "required":[ + "displayName", + "amountRequirementName", + "maxCount", + "createdAt", + "createdBy", + "farmId", + "limitId", + "currentCount" + ], + "members":{ + "displayName":{ + "shape":"ResourceName", + "documentation":"<p>The name of the limit used in lists to identify the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>" + }, + "amountRequirementName":{ + "shape":"AmountRequirementName", + "documentation":"<p>The value that you specify as the <code>name</code> in the <code>amounts</code> field of the <code>hostRequirements</code> in a step of a job template to declare the limit requirement.</p>" + }, + "maxCount":{ + "shape":"MaxCount", + "documentation":"<p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>The <code>maxValue</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>" + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"<p>The Unix timestamp of the date and time that the limit was created.</p>" + }, + "createdBy":{ + "shape":"CreatedBy", + "documentation":"<p>The user identifier of the person that created the limit.</p>" + }, + "updatedAt":{ + "shape":"UpdatedAt", + "documentation":"<p>The Unix timestamp of the date and time that the limit was last updated.</p>" + }, + "updatedBy":{ + "shape":"UpdatedBy", + "documentation":"<p>The user identifier of the person that last updated the limit.</p>" + }, + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the limit.</p>" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit.</p>" + }, + "currentCount":{ + "shape":"MinZeroMaxInteger", + "documentation":"<p>The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.</p>" + } + }, + "documentation":"<p>Provides information about a specific limit.</p>" + }, "ListAttributeCapabilityValue":{ "type":"list", "member":{"shape":"AttributeCapabilityValue"} @@ -7489,6 +8079,44 @@ } } }, + "ListLimitsRequest":{ + "type":"structure", + "required":["farmId"], + "members":{ + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the limits.</p>", + "location":"uri", + "locationName":"farmId" + }, + "nextToken":{ + "shape":"String", + "documentation":"<p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"<p>The maximum number of limits to return in each page of results.</p>", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListLimitsResponse":{ + "type":"structure", + "required":["limits"], + "members":{ + "limits":{ + "shape":"LimitSummaries", + "documentation":"<p>A list of limits that the farm contains.</p>" + }, + "nextToken":{ + "shape":"String", + "documentation":"<p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>" + } + } + }, "ListMeteredProductsRequest":{ "type":"structure", "required":["licenseEndpointId"], @@ -7655,6 +8283,56 @@ } } }, + "ListQueueLimitAssociationsRequest":{ + "type":"structure", + "required":["farmId"], + "members":{ + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the limits and associations.</p>", + "location":"uri", + "locationName":"farmId" + }, + "queueId":{ + "shape":"QueueId", + "documentation":"<p>Specifies that the operation should return only the queue limit associations for the specified queue. If you specify both the <code>queueId</code> and the <code>limitId</code>, only the specified limit is returned if it exists.</p>", + "location":"querystring", + "locationName":"queueId" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>Specifies that the operation should return only the queue limit associations for the specified limit. If you specify both the <code>queueId</code> and the <code>limitId</code>, only the specified limit is returned if it exists.</p>", + "location":"querystring", + "locationName":"limitId" + }, + "nextToken":{ + "shape":"String", + "documentation":"<p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"<p>The maximum number of associations to return in each page of results.</p>", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListQueueLimitAssociationsResponse":{ + "type":"structure", + "required":["queueLimitAssociations"], + "members":{ + "queueLimitAssociations":{ + "shape":"QueueLimitAssociationSummaries", + "documentation":"<p>A list of associations between limits and queues in the farm specified in the request.</p>" + }, + "nextToken":{ + "shape":"String", + "documentation":"<p>If Deadline Cloud returns <code>nextToken</code>, then there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 <code>ValidationException</code> error.</p>" + } + } + }, "ListQueueMembersRequest":{ "type":"structure", "required":[ @@ -8411,7 +9089,7 @@ }, "inputManifestHash":{ "shape":"ManifestPropertiesInputManifestHashString", - "documentation":"<p>The has value of the file.</p>" + "documentation":"<p>The hash value of the file.</p>" } }, "documentation":"<p>The details of the manifest that links a job's source information.</p>", @@ -8438,6 +9116,12 @@ "max":1024, "min":1 }, + "MaxCount":{ + "type":"integer", + "box":true, + "max":2147483647, + "min":-1 + }, "MaxFailedTasksCount":{ "type":"integer", "box":true, @@ -8456,6 +9140,12 @@ "max":2147483647, "min":0 }, + "MaxWorkerCount":{ + "type":"integer", + "box":true, + "max":2147483647, + "min":-1 + }, "MembershipLevel":{ "type":"string", "enum":[ @@ -8522,6 +9212,12 @@ "type":"list", "member":{"shape":"MeteredProductSummary"} }, + "MinOneMaxInteger":{ + "type":"integer", + "box":true, + "max":2147483647, + "min":1 + }, "MinOneMaxTenThousand":{ "type":"integer", "box":true, @@ -8912,6 +9608,60 @@ "type":"string", "pattern":"queue-[0-9a-f]{32}" }, + "QueueLimitAssociationStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS", + "STOP_LIMIT_USAGE_AND_CANCEL_TASKS", + "STOPPED" + ] + }, + "QueueLimitAssociationSummaries":{ + "type":"list", + "member":{"shape":"QueueLimitAssociationSummary"} + }, + "QueueLimitAssociationSummary":{ + "type":"structure", + "required":[ + "createdAt", + "createdBy", + "queueId", + "limitId", + "status" + ], + "members":{ + "createdAt":{ + "shape":"CreatedAt", + "documentation":"<p>The Unix timestamp of the date and time that the association was created.</p>" + }, + "createdBy":{ + "shape":"CreatedBy", + "documentation":"<p>The user identifier of the person that created the association.</p>" + }, + "updatedAt":{ + "shape":"UpdatedAt", + "documentation":"<p>The Unix timestamp of the date and time that the association was last updated.</p>" + }, + "updatedBy":{ + "shape":"UpdatedBy", + "documentation":"<p>The user identifier of the person that updated the association.</p>" + }, + "queueId":{ + "shape":"QueueId", + "documentation":"<p>The unique identifier of the queue in the association.</p>" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit in the association.</p>" + }, + "status":{ + "shape":"QueueLimitAssociationStatus", + "documentation":"<p>The status of task scheduling in the queue-limit association.</p> <ul> <li> <p> <code>ACTIVE</code> - Association is active.</p> </li> <li> <p> <code>STOP_LIMIT_USAGE_AND_COMPLETE_TASKS</code> - Association has stopped scheduling new tasks and is completing current tasks.</p> </li> <li> <p> <code>STOP_LIMIT_USAGE_AND_CANCEL_TASKS</code> - Association has stopped scheduling new tasks and is canceling current tasks.</p> </li> <li> <p> <code>STOPPED</code> - Association has been stopped.</p> </li> </ul>" + } + }, + "documentation":"<p>Provides information about the association between a queue and a limit.</p>" + }, "QueueMember":{ "type":"structure", "required":[ @@ -9587,7 +10337,7 @@ }, "acceleratorCapabilities":{ "shape":"AcceleratorCapabilities", - "documentation":"<p>The GPU accelerator capabilities required for the Amazon EC2 instances. If you include the <code>acceleratorCapabilities</code> property in the <a href=\"https://docs.aws.amazon.com/deadline-cloud/latest/APIReference/API_ServiceManagedEc2InstanceCapabilities\">ServiceManagedEc2InstanceCapabilities</a> object, all of the Amazon EC2 instances will have at least one accelerator. </p>" + "documentation":"<p>Describes the GPU accelerator capabilities required for worker host instances in this fleet.</p>" }, "allowedInstanceTypes":{ "shape":"InstanceTypes", @@ -11085,6 +11835,30 @@ "location":"header", "locationName":"X-Amz-Client-Token" }, + "targetTaskRunStatus":{ + "shape":"JobTargetTaskRunStatus", + "documentation":"<p>The task status to update the job's tasks to.</p>" + }, + "priority":{ + "shape":"JobPriority", + "documentation":"<p>The job priority to update.</p>" + }, + "maxFailedTasksCount":{ + "shape":"MaxFailedTasksCount", + "documentation":"<p>The number of task failures before the job stops running and is marked as <code>FAILED</code>.</p>" + }, + "maxRetriesPerTask":{ + "shape":"MaxRetriesPerTask", + "documentation":"<p>The maximum number of retries for a job.</p>" + }, + "lifecycleStatus":{ + "shape":"UpdateJobLifecycleStatus", + "documentation":"<p>The status of a job in its lifecycle. When you change the status of the job to <code>ARCHIVED</code>, the job can't be scheduled or archived.</p> <important> <p>An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.</p> </important>" + }, + "maxWorkerCount":{ + "shape":"MaxWorkerCount", + "documentation":"<p>The maximum number of worker hosts that can concurrently process a job. When the <code>maxWorkerCount</code> is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.</p> <p>You can't set the <code>maxWorkerCount</code> to 0. If you set it to -1, there is no maximum number of workers.</p> <p>If you don't specify the <code>maxWorkerCount</code>, the default is -1.</p> <p>The maximum number of workers that can process tasks in the job.</p>" + }, "farmId":{ "shape":"FarmId", "documentation":"<p>The farm ID of the job to update.</p>", @@ -11102,30 +11876,48 @@ "documentation":"<p>The job ID to update.</p>", "location":"uri", "locationName":"jobId" + } + } + }, + "UpdateJobResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateLimitRequest":{ + "type":"structure", + "required":[ + "farmId", + "limitId" + ], + "members":{ + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the limit.</p>", + "location":"uri", + "locationName":"farmId" }, - "targetTaskRunStatus":{ - "shape":"JobTargetTaskRunStatus", - "documentation":"<p>The task status to update the job's tasks to.</p>" - }, - "priority":{ - "shape":"JobPriority", - "documentation":"<p>The job priority to update.</p>" + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit to update.</p>", + "location":"uri", + "locationName":"limitId" }, - "maxFailedTasksCount":{ - "shape":"MaxFailedTasksCount", - "documentation":"<p>The number of task failures before the job stops running and is marked as <code>FAILED</code>.</p>" + "displayName":{ + "shape":"ResourceName", + "documentation":"<p>The new display name of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>" }, - "maxRetriesPerTask":{ - "shape":"MaxRetriesPerTask", - "documentation":"<p>The maximum number of retries for a job.</p>" + "description":{ + "shape":"Description", + "documentation":"<p>The new description of the limit.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>" }, - "lifecycleStatus":{ - "shape":"UpdateJobLifecycleStatus", - "documentation":"<p>The status of a job in its lifecycle. When you change the status of the job to <code>ARCHIVED</code>, the job can't be scheduled or archived.</p> <important> <p>An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.</p> </important>" + "maxCount":{ + "shape":"MaxCount", + "documentation":"<p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.</p> <p>The <code>maxCount</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>" } } }, - "UpdateJobResponse":{ + "UpdateLimitResponse":{ "type":"structure", "members":{ } @@ -11257,6 +12049,52 @@ "STOP_SCHEDULING_AND_CANCEL_TASKS" ] }, + "UpdateQueueLimitAssociationRequest":{ + "type":"structure", + "required":[ + "farmId", + "queueId", + "limitId", + "status" + ], + "members":{ + "farmId":{ + "shape":"FarmId", + "documentation":"<p>The unique identifier of the farm that contains the associated queues and limits.</p>", + "location":"uri", + "locationName":"farmId" + }, + "queueId":{ + "shape":"QueueId", + "documentation":"<p>The unique identifier of the queue associated to the limit.</p>", + "location":"uri", + "locationName":"queueId" + }, + "limitId":{ + "shape":"LimitId", + "documentation":"<p>The unique identifier of the limit associated to the queue.</p>", + "location":"uri", + "locationName":"limitId" + }, + "status":{ + "shape":"UpdateQueueLimitAssociationStatus", + "documentation":"<p>Sets the status of the limit. You can mark the limit active, or you can stop usage of the limit and either complete existing tasks or cancel any existing tasks immediately. </p>" + } + } + }, + "UpdateQueueLimitAssociationResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateQueueLimitAssociationStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "STOP_LIMIT_USAGE_AND_COMPLETE_TASKS", + "STOP_LIMIT_USAGE_AND_CANCEL_TASKS" + ] + }, "UpdateQueueRequest":{ "type":"structure", "required":[ @@ -11333,11 +12171,11 @@ "UpdateSessionRequest":{ "type":"structure", "required":[ + "targetLifecycleStatus", "farmId", "queueId", "jobId", - "sessionId", - "targetLifecycleStatus" + "sessionId" ], "members":{ "clientToken":{ @@ -11347,6 +12185,10 @@ "location":"header", "locationName":"X-Amz-Client-Token" }, + "targetLifecycleStatus":{ + "shape":"SessionLifecycleTargetStatus", + "documentation":"<p>The life cycle status to update in the session.</p>" + }, "farmId":{ "shape":"FarmId", "documentation":"<p>The farm ID to update in the session.</p>", @@ -11370,10 +12212,6 @@ "documentation":"<p>The session ID to update.</p>", "location":"uri", "locationName":"sessionId" - }, - "targetLifecycleStatus":{ - "shape":"SessionLifecycleTargetStatus", - "documentation":"<p>The life cycle status to update in the session.</p>" } } }, @@ -11385,13 +12223,17 @@ "UpdateStepRequest":{ "type":"structure", "required":[ + "targetTaskRunStatus", "farmId", "queueId", "jobId", - "stepId", - "targetTaskRunStatus" + "stepId" ], "members":{ + "targetTaskRunStatus":{ + "shape":"StepTargetTaskRunStatus", + "documentation":"<p>The task status to update the step's tasks to.</p>" + }, "clientToken":{ "shape":"ClientToken", "documentation":"<p>The unique token which the server uses to recognize retries of the same request.</p>", @@ -11422,10 +12264,6 @@ "documentation":"<p>The step ID to update.</p>", "location":"uri", "locationName":"stepId" - }, - "targetTaskRunStatus":{ - "shape":"StepTargetTaskRunStatus", - "documentation":"<p>The task status to update the step's tasks to.</p>" } } }, @@ -11486,12 +12324,12 @@ "UpdateTaskRequest":{ "type":"structure", "required":[ + "targetRunStatus", "farmId", "queueId", "jobId", "stepId", - "taskId", - "targetRunStatus" + "taskId" ], "members":{ "clientToken":{ @@ -11501,6 +12339,10 @@ "location":"header", "locationName":"X-Amz-Client-Token" }, + "targetRunStatus":{ + "shape":"TaskTargetRunStatus", + "documentation":"<p>The run status with which to start the task.</p>" + }, "farmId":{ "shape":"FarmId", "documentation":"<p>The farm ID to update.</p>", @@ -11530,10 +12372,6 @@ "documentation":"<p>The task ID to update.</p>", "location":"uri", "locationName":"taskId" - }, - "targetRunStatus":{ - "shape":"TaskTargetRunStatus", - "documentation":"<p>The run status with which to start the task.</p>" } } }, diff --git a/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/waiters-2.json b/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/waiters-2.json index 7cb6d90abee..eb6bcc6dfc6 100644 --- a/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/waiters-2.json +++ b/contrib/python/botocore/py3/botocore/data/deadline/2023-10-12/waiters-2.json @@ -105,6 +105,18 @@ "expected" : "STOPPED" } ] }, + "QueueLimitAssociationStopped" : { + "description" : "Wait until a QueueLimitAssociation is stopped. Use this after setting the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS to wait for a QueueLimitAssociation to reach STOPPED", + "delay" : 10, + "maxAttempts" : 60, + "operation" : "GetQueueLimitAssociation", + "acceptors" : [ { + "matcher" : "path", + "argument" : "status", + "state" : "success", + "expected" : "STOPPED" + } ] + }, "QueueScheduling" : { "delay" : 10, "maxAttempts" : 70, diff --git a/contrib/python/botocore/py3/botocore/data/detective/2018-10-26/service-2.json b/contrib/python/botocore/py3/botocore/data/detective/2018-10-26/service-2.json index 3bfa54668f4..12ae8c2ced4 100644 --- a/contrib/python/botocore/py3/botocore/data/detective/2018-10-26/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/detective/2018-10-26/service-2.json @@ -5,11 +5,13 @@ "endpointPrefix":"api.detective", "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"Amazon Detective", "serviceId":"Detective", "signatureVersion":"v4", "signingName":"detective", - "uid":"detective-2018-10-26" + "uid":"detective-2018-10-26", + "auth":["aws.auth#sigv4"] }, "operations":{ "AcceptInvitation":{ @@ -446,7 +448,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"} ], - "documentation":"<p>Starts a data source packages for the behavior graph.</p>" + "documentation":"<p>Starts a data source package for the Detective behavior graph.</p>" }, "UpdateInvestigationState":{ "name":"UpdateInvestigationState", @@ -1154,7 +1156,7 @@ "documentation":"<p>Contains details about related finding groups.</p>" } }, - "documentation":"<p>Details about the indicators of compromise which are used to determine if a resource is involved in a security incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. For the list of indicators of compromise that are generated by Detective investigations, see <a href=\"https://docs.aws.amazon.com/detective/latest/userguide/detective-investigations.html\">Detective investigations</a>.</p>" + "documentation":"<p>Details about the indicators of compromise which are used to determine if a resource is involved in a security incident. An indicator of compromise (IOC) is an artifact observed in or on a network, system, or environment that can (with a high level of confidence) identify malicious activity or a security incident. For the list of indicators of compromise that are generated by Detective investigations, see <a href=\"https://docs.aws.amazon.com/detective/latest/userguide/detective-investigation-about.html\">Detective investigations</a>.</p>" }, "IndicatorType":{ "type":"string", @@ -1314,7 +1316,7 @@ }, "IndicatorType":{ "shape":"IndicatorType", - "documentation":"<p>For the list of indicators of compromise that are generated by Detective investigations, see <a href=\"https://docs.aws.amazon.com/detective/latest/userguide/detective-investigations.html\">Detective investigations</a>.</p>" + "documentation":"<p>For the list of indicators of compromise that are generated by Detective investigations, see <a href=\"https://docs.aws.amazon.com/detective/latest/userguide/detective-investigation-about.html\">Detective investigations</a>.</p>" }, "NextToken":{ "shape":"AiPaginationToken", @@ -2047,7 +2049,7 @@ }, "DatasourcePackages":{ "shape":"DatasourcePackageList", - "documentation":"<p>The data source package start for the behavior graph.</p>" + "documentation":"<p>The data source package to start for the behavior graph.</p>" } } }, @@ -2116,5 +2118,5 @@ "value":{"shape":"DatasourcePackageUsageInfo"} } }, - "documentation":"<p>Detective uses machine learning and purpose-built visualizations to help you to analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.</p> <p>The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by an administrator account.</p> <p>To add a member account to the behavior graph, the administrator account sends an invitation to the account. When the account accepts the invitation, it becomes a member account in the behavior graph.</p> <p>Detective is also integrated with Organizations. The organization management account designates the Detective administrator account for the organization. That account becomes the administrator account for the organization behavior graph. The Detective administrator account is also the delegated administrator account for Detective in Organizations.</p> <p>The Detective administrator account can enable any organization account as a member account in the organization behavior graph. The organization accounts do not receive invitations. The Detective administrator account can also invite other accounts to the organization behavior graph.</p> <p>Every behavior graph is specific to a Region. You can only use the API to manage behavior graphs that belong to the Region that is associated with the currently selected endpoint.</p> <p>The administrator account for a behavior graph can use the Detective API to do the following:</p> <ul> <li> <p>Enable and disable Detective. Enabling Detective creates a new behavior graph.</p> </li> <li> <p>View the list of member accounts in a behavior graph.</p> </li> <li> <p>Add member accounts to a behavior graph.</p> </li> <li> <p>Remove member accounts from a behavior graph.</p> </li> <li> <p>Apply tags to a behavior graph.</p> </li> </ul> <p>The organization management account can use the Detective API to select the delegated administrator for Detective.</p> <p>The Detective administrator account for an organization can use the Detective API to do the following:</p> <ul> <li> <p>Perform all of the functions of an administrator account.</p> </li> <li> <p>Determine whether to automatically enable new organization accounts as member accounts in the organization behavior graph.</p> </li> </ul> <p>An invited member account can use the Detective API to do the following:</p> <ul> <li> <p>View the list of behavior graphs that they are invited to.</p> </li> <li> <p>Accept an invitation to contribute to a behavior graph.</p> </li> <li> <p>Decline an invitation to contribute to a behavior graph.</p> </li> <li> <p>Remove their account from a behavior graph.</p> </li> </ul> <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p> <note> <p>We replaced the term \"master account\" with the term \"administrator account\". An administrator account is used to centrally manage multiple accounts. In the case of Detective, the administrator account manages the accounts in their behavior graph.</p> </note>" + "documentation":"<p>Detective uses machine learning and purpose-built visualizations to help you to analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.</p> <p>The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by an administrator account.</p> <p>To add a member account to the behavior graph, the administrator account sends an invitation to the account. When the account accepts the invitation, it becomes a member account in the behavior graph.</p> <p>Detective is also integrated with Organizations. The organization management account designates the Detective administrator account for the organization. That account becomes the administrator account for the organization behavior graph. The Detective administrator account is also the delegated administrator account for Detective in Organizations.</p> <p>The Detective administrator account can enable any organization account as a member account in the organization behavior graph. The organization accounts do not receive invitations. The Detective administrator account can also invite other accounts to the organization behavior graph.</p> <p>Every behavior graph is specific to a Region. You can only use the API to manage behavior graphs that belong to the Region that is associated with the currently selected endpoint.</p> <p>The administrator account for a behavior graph can use the Detective API to do the following:</p> <ul> <li> <p>Enable and disable Detective. Enabling Detective creates a new behavior graph.</p> </li> <li> <p>View the list of member accounts in a behavior graph.</p> </li> <li> <p>Add member accounts to a behavior graph.</p> </li> <li> <p>Remove member accounts from a behavior graph.</p> </li> <li> <p>Apply tags to a behavior graph.</p> </li> </ul> <p>The organization management account can use the Detective API to select the delegated administrator for Detective.</p> <p>The Detective administrator account for an organization can use the Detective API to do the following:</p> <ul> <li> <p>Perform all of the functions of an administrator account.</p> </li> <li> <p>Determine whether to automatically enable new organization accounts as member accounts in the organization behavior graph.</p> </li> </ul> <p>An invited member account can use the Detective API to do the following:</p> <ul> <li> <p>View the list of behavior graphs that they are invited to.</p> </li> <li> <p>Accept an invitation to contribute to a behavior graph.</p> </li> <li> <p>Decline an invitation to contribute to a behavior graph.</p> </li> <li> <p>Remove their account from a behavior graph.</p> </li> </ul> <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/userguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p> <note> <p>We replaced the term \"master account\" with the term \"administrator account\". An administrator account is used to centrally manage multiple accounts. In the case of Detective, the administrator account manages the accounts in their behavior graph.</p> </note>" } diff --git a/contrib/python/botocore/py3/botocore/data/dms/2016-01-01/service-2.json b/contrib/python/botocore/py3/botocore/data/dms/2016-01-01/service-2.json index cb44f5db0b2..13f7485e9cb 100644 --- a/contrib/python/botocore/py3/botocore/data/dms/2016-01-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/dms/2016-01-01/service-2.json @@ -865,7 +865,7 @@ "errors":[ {"shape":"ResourceNotFoundFault"} ], - "documentation":"<p>For internal use only</p>" + "documentation":"<p>Returns a list of upcoming maintenance events for replication instances in your account in the current Region.</p>" }, "DescribeRecommendationLimitations":{ "name":"DescribeRecommendationLimitations", @@ -1773,7 +1773,7 @@ }, "ApplyAction":{ "shape":"String", - "documentation":"<p>The pending maintenance action to apply to this resource.</p> <p>Valid values: <code>os-upgrade</code>, <code>system-update</code>, <code>db-upgrade</code> </p>" + "documentation":"<p>The pending maintenance action to apply to this resource.</p> <p>Valid values: <code>os-upgrade</code>, <code>system-update</code>, <code>db-upgrade</code>, <code>os-patch</code> </p>" }, "OptInType":{ "shape":"String", @@ -2202,6 +2202,10 @@ "shape":"SourceDataSettings", "documentation":"<p>Specifies information about the source data provider.</p>" }, + "TargetDataSettings":{ + "shape":"TargetDataSettings", + "documentation":"<p>Specifies information about the target data provider.</p>" + }, "NumberOfJobs":{ "shape":"IntegerOptional", "documentation":"<p>The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.</p>" @@ -2242,7 +2246,7 @@ }, "Engine":{ "shape":"String", - "documentation":"<p>The type of database engine for the data provider. Valid values include <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"sqlserver\"</code>, <code>redshift</code>, <code>mariadb</code>, <code>mongodb</code>, and <code>docdb</code>. A value of <code>\"aurora\"</code> represents Amazon Aurora MySQL-Compatible Edition.</p>" + "documentation":"<p>The type of database engine for the data provider. Valid values include <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"sqlserver\"</code>, <code>redshift</code>, <code>mariadb</code>, <code>mongodb</code>, <code>db2</code>, <code>db2-zos</code> and <code>docdb</code>. A value of <code>\"aurora\"</code> represents Amazon Aurora MySQL-Compatible Edition.</p>" }, "Settings":{ "shape":"DataProviderSettings", @@ -2755,7 +2759,7 @@ }, "KerberosAuthenticationSettings":{ "shape":"KerberosAuthenticationSettings", - "documentation":"<p>Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when creating a replication instance.</p>" + "documentation":"<p>Specifies the settings required for kerberos authentication when creating the replication instance.</p>" } }, "documentation":"<p/>" @@ -2933,6 +2937,10 @@ "shape":"SourceDataSettings", "documentation":"<p>Specifies information about the data migration's source data provider.</p>" }, + "TargetDataSettings":{ + "shape":"TargetDataSettings", + "documentation":"<p>Specifies information about the data migration's target data provider.</p>" + }, "DataMigrationStatistics":{ "shape":"DataMigrationStatistics", "documentation":"<p>Provides information about the data migration's run, including start and stop time, latency, and data migration progress.</p>" @@ -3049,7 +3057,7 @@ }, "Engine":{ "shape":"String", - "documentation":"<p>The type of database engine for the data provider. Valid values include <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"sqlserver\"</code>, <code>redshift</code>, <code>mariadb</code>, <code>mongodb</code>, and <code>docdb</code>. A value of <code>\"aurora\"</code> represents Amazon Aurora MySQL-Compatible Edition.</p>" + "documentation":"<p>The type of database engine for the data provider. Valid values include <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"sqlserver\"</code>, <code>redshift</code>, <code>mariadb</code>, <code>mongodb</code>, <code>db2</code>, <code>db2-zos</code> and <code>docdb</code>. A value of <code>\"aurora\"</code> represents Amazon Aurora MySQL-Compatible Edition.</p>" }, "Settings":{ "shape":"DataProviderSettings", @@ -3124,6 +3132,14 @@ "shape":"MariaDbDataProviderSettings", "documentation":"<p>Provides information that defines a MariaDB data provider.</p>" }, + "IbmDb2LuwSettings":{ + "shape":"IbmDb2LuwDataProviderSettings", + "documentation":"<p>Provides information that defines an IBM DB2 LUW data provider.</p>" + }, + "IbmDb2zOsSettings":{ + "shape":"IbmDb2zOsDataProviderSettings", + "documentation":"<p>Provides information that defines an IBM DB2 for z/OS data provider.</p>" + }, "MongoDbSettings":{ "shape":"MongoDbDataProviderSettings", "documentation":"<p>Provides information that defines a MongoDB data provider.</p>" @@ -3588,6 +3604,10 @@ "shape":"String", "documentation":"<p>ARN of a replication instance on which you want to base the default list of individual assessments.</p>" }, + "ReplicationConfigArn":{ + "shape":"String", + "documentation":"<p>Amazon Resource Name (ARN) of a serverless replication on which you want to base the default list of individual assessments.</p>" + }, "SourceEngineName":{ "shape":"String", "documentation":"<p>Name of a database engine that the specified replication instance supports as a source.</p>" @@ -5796,6 +5816,58 @@ }, "documentation":"<p>Provides information that defines an IBM Db2 LUW endpoint.</p>" }, + "IbmDb2LuwDataProviderSettings":{ + "type":"structure", + "members":{ + "ServerName":{ + "shape":"String", + "documentation":"<p>The name of the DB2 LUW server.</p>" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"<p>The port value for the DB2 LUW data provider.</p>" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"<p>The database name on the DB2 LUW data provider.</p>" + }, + "SslMode":{ + "shape":"DmsSslModeValue", + "documentation":"<p>The SSL mode used to connect to the DB2 LUW data provider. The default value is <code>none</code>. Valid Values: <code>none</code> and <code>verify-ca</code>.</p>" + }, + "CertificateArn":{ + "shape":"String", + "documentation":"<p>The Amazon Resource Name (ARN) of the certificate used for SSL connection.</p>" + } + }, + "documentation":"<p>Provides information about an IBM DB2 LUW data provider.</p>" + }, + "IbmDb2zOsDataProviderSettings":{ + "type":"structure", + "members":{ + "ServerName":{ + "shape":"String", + "documentation":"<p>The name of the DB2 for z/OS server.</p>" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"<p>The port value for the DB2 for z/OS data provider.</p>" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"<p>The database name on the DB2 for z/OS data provider.</p>" + }, + "SslMode":{ + "shape":"DmsSslModeValue", + "documentation":"<p>The SSL mode used to connect to the DB2 for z/OS data provider. The default value is <code>none</code>. Valid Values: <code>none</code> and <code>verify-ca</code>.</p>" + }, + "CertificateArn":{ + "shape":"String", + "documentation":"<p>The Amazon Resource Name (ARN) of the certificate used for SSL connection.</p>" + } + }, + "documentation":"<p>Provides information about an IBM DB2 for z/OS data provider.</p>" + }, "ImportCertificateMessage":{ "type":"structure", "required":["CertificateIdentifier"], @@ -6135,18 +6207,18 @@ "members":{ "KeyCacheSecretId":{ "shape":"String", - "documentation":"<p>Specifies the secret ID of the key cache for the replication instance.</p>" + "documentation":"<p>Specifies the ID of the secret that stores the key cache file required for kerberos authentication.</p>" }, "KeyCacheSecretIamArn":{ "shape":"String", - "documentation":"<p>Specifies the Amazon Resource Name (ARN) of the IAM role that grants Amazon Web Services DMS access to the secret containing key cache file for the replication instance.</p>" + "documentation":"<p>Specifies the Amazon Resource Name (ARN) of the IAM role that grants Amazon Web Services DMS access to the secret containing key cache file for the kerberos authentication.</p>" }, "Krb5FileContents":{ "shape":"String", - "documentation":"<p>Specifies the ID of the secret that stores the key cache file required for kerberos authentication of the replication instance.</p>" + "documentation":"<p>Specifies the contents of krb5 configuration file required for kerberos authentication.</p>" } }, - "documentation":"<p>Specifies using Kerberos authentication settings for use with DMS.</p>" + "documentation":"<p>Specifies the settings required for kerberos authentication when creating the replication instance.</p>" }, "KeyList":{ "type":"list", @@ -6376,7 +6448,7 @@ }, "AuthenticationMethod":{ "shape":"SqlServerAuthenticationMethod", - "documentation":"<p>Specifies using Kerberos authentication with Microsoft SQL Server.</p>" + "documentation":"<p>Specifies the authentication method to be used with Microsoft SQL Server.</p>" } }, "documentation":"<p>Provides information that defines a Microsoft SQL Server endpoint.</p>" @@ -6519,6 +6591,10 @@ "shape":"SourceDataSettings", "documentation":"<p>The new information about the source data provider for the data migration.</p>" }, + "TargetDataSettings":{ + "shape":"TargetDataSettings", + "documentation":"<p>The new information about the target data provider for the data migration.</p>" + }, "NumberOfJobs":{ "shape":"IntegerOptional", "documentation":"<p>The number of parallel jobs that trigger parallel threads to unload the tables from the source, and then load them to the target.</p>" @@ -6556,7 +6632,7 @@ }, "Engine":{ "shape":"String", - "documentation":"<p>The type of database engine for the data provider. Valid values include <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"sqlserver\"</code>, <code>redshift</code>, <code>mariadb</code>, <code>mongodb</code>, and <code>docdb</code>. A value of <code>\"aurora\"</code> represents Amazon Aurora MySQL-Compatible Edition.</p>" + "documentation":"<p>The type of database engine for the data provider. Valid values include <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"sqlserver\"</code>, <code>redshift</code>, <code>mariadb</code>, <code>mongodb</code>, <code>db2</code>, <code>db2-zos</code> and <code>docdb</code>. A value of <code>\"aurora\"</code> represents Amazon Aurora MySQL-Compatible Edition.</p>" }, "ExactSettings":{ "shape":"BooleanOptional", @@ -6968,7 +7044,7 @@ }, "KerberosAuthenticationSettings":{ "shape":"KerberosAuthenticationSettings", - "documentation":"<p>Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when modifying a replication instance.</p>" + "documentation":"<p>Specifies the settings required for kerberos authentication when modifying a replication instance.</p>" } }, "documentation":"<p/>" @@ -7567,7 +7643,7 @@ }, "AuthenticationMethod":{ "shape":"OracleAuthenticationMethod", - "documentation":"<p>Specifies using Kerberos authentication with Oracle.</p>" + "documentation":"<p>Specifies the authentication method to be used with Oracle.</p>" } }, "documentation":"<p>Provides information that defines an Oracle endpoint.</p>" @@ -7810,6 +7886,54 @@ }, "documentation":"<p>Provides information that defines a PostgreSQL data provider.</p>" }, + "PremigrationAssessmentStatus":{ + "type":"structure", + "members":{ + "PremigrationAssessmentRunArn":{ + "shape":"String", + "documentation":"<p>The Amazon Resource Name (ARN) of this assessment run.</p>" + }, + "FailOnAssessmentFailure":{ + "shape":"Boolean", + "documentation":"<p>A configurable setting you can set to <code>true</code> (the defualt setting) or <code>false</code>. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.</p>" + }, + "Status":{ + "shape":"String", + "documentation":"<p>This describes the assessment run status. The status can be one of the following values:</p> <ul> <li> <p> <code>cancelling</code>: The assessment run was canceled.</p> </li> <li> <p> <code>deleting</code>: The assessment run was deleted.</p> </li> <li> <p> <code>failed</code>: At least one individual assessment completed with a failed status. </p> </li> <li> <p> <code>error-provisioning</code>: An internal error occurred while resources were provisioned (during the <code>provisioning</code> status).</p> </li> <li> <p> <code>error-executing</code> An internal error occurred while individual assessments ran (during the <code>running</code> status).</p> </li> <li> <p> <code>invalid state</code>: The assessment run is in an unknown state. </p> </li> <li> <p> <code>passed</code>: All individual assessments have completed and none have a failed status.</p> </li> <li> <p> <code>provisioning</code>: The resources required to run individual assessments are being provisioned. </p> </li> <li> <p> <code>running</code>: Individual assessments are being run. </p> </li> <li> <p> <code>starting</code>: The assessment run is starting, but resources are not yet being provisioned for individual assessments. </p> </li> <li> <p> <code>warning</code>: At least one individual assessment completed with a warning status. </p> </li> </ul>" + }, + "PremigrationAssessmentRunCreationDate":{ + "shape":"TStamp", + "documentation":"<p>The date which the assessment run was created.</p>" + }, + "AssessmentProgress":{"shape":"ReplicationTaskAssessmentRunProgress"}, + "LastFailureMessage":{ + "shape":"String", + "documentation":"<p>The last message generated by an individual assessment failure.</p>" + }, + "ResultLocationBucket":{ + "shape":"String", + "documentation":"<p>The Amazon S3 bucket that Database Migration Service Serverless created to store the results of this assessment run.</p>" + }, + "ResultLocationFolder":{ + "shape":"String", + "documentation":"<p>The folder within an Amazon S3 bucket where you want Database Migration Service to store the results of this assessment run.</p>" + }, + "ResultEncryptionMode":{ + "shape":"String", + "documentation":"<p>The supported values are <code>SSE_KMS</code> and <code>SSE_S3</code>. If these values are not provided, then the files are not encrypted at rest. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.KMSKeys\">Creating Amazon Web Services KMS keys to encrypt Amazon S3 target objects</a>.</p>" + }, + "ResultKmsKeyArn":{ + "shape":"String", + "documentation":"<p>The ARN of a custom KMS encryption key that you specify when you set <code>ResultEncryptionMode</code> to <code>SSE_KMS</code>.</p>" + }, + "ResultStatistic":{"shape":"ReplicationTaskAssessmentRunResultStatistic"} + }, + "documentation":"<p>The results returned in <code>describe-replications</code> to display the results of the premigration assessment from the replication configuration.</p>" + }, + "PremigrationAssessmentStatusList":{ + "type":"list", + "member":{"shape":"PremigrationAssessmentStatus"} + }, "ProvisionData":{ "type":"structure", "members":{ @@ -8415,6 +8539,10 @@ "shape":"ProvisionData", "documentation":"<p>Information about provisioning resources for an DMS serverless replication.</p>" }, + "PremigrationAssessmentStatuses":{ + "shape":"PremigrationAssessmentStatusList", + "documentation":"<p>The status output of premigration assessment in describe-replications.</p>" + }, "StopReason":{ "shape":"String", "documentation":"<p>The reason the replication task was stopped. This response parameter can return one of the following values:</p> <ul> <li> <p> <code>\"Stop Reason NORMAL\"</code> </p> </li> <li> <p> <code>\"Stop Reason RECOVERABLE_ERROR\"</code> </p> </li> <li> <p> <code>\"Stop Reason FATAL_ERROR\"</code> </p> </li> <li> <p> <code>\"Stop Reason FULL_LOAD_ONLY_FINISHED\"</code> </p> </li> <li> <p> <code>\"Stop Reason STOPPED_AFTER_FULL_LOAD\"</code> – Full load completed, with cached changes not applied</p> </li> <li> <p> <code>\"Stop Reason STOPPED_AFTER_CACHED_EVENTS\"</code> – Full load completed, with cached changes applied</p> </li> <li> <p> <code>\"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED\"</code> </p> </li> <li> <p> <code>\"Stop Reason STOPPED_AFTER_DDL_APPLY\"</code> – User-defined stop task after DDL applied</p> </li> <li> <p> <code>\"Stop Reason STOPPED_DUE_TO_LOW_MEMORY\"</code> </p> </li> <li> <p> <code>\"Stop Reason STOPPED_DUE_TO_LOW_DISK\"</code> </p> </li> <li> <p> <code>\"Stop Reason STOPPED_AT_SERVER_TIME\"</code> – User-defined server time for stopping task</p> </li> <li> <p> <code>\"Stop Reason STOPPED_AT_COMMIT_TIME\"</code> – User-defined commit time for stopping task</p> </li> <li> <p> <code>\"Stop Reason RECONFIGURATION_RESTART\"</code> </p> </li> <li> <p> <code>\"Stop Reason RECYCLE_TASK\"</code> </p> </li> </ul>" @@ -8634,7 +8762,7 @@ }, "KerberosAuthenticationSettings":{ "shape":"KerberosAuthenticationSettings", - "documentation":"<p>Specifies the ID of the secret that stores the key cache file required for kerberos authentication, when replicating an instance.</p>" + "documentation":"<p>Specifies the settings required for kerberos authentication when replicating an instance.</p>" } }, "documentation":"<p>Provides information that defines a replication instance.</p>" @@ -9829,6 +9957,10 @@ "shape":"String", "documentation":"<p>The replication type.</p> <p>When the replication type is <code>full-load</code> or <code>full-load-and-cdc</code>, the only valid value for the first run of the replication is <code>start-replication</code>. This option will start the replication.</p> <p>You can also use <a>ReloadTables</a> to reload specific tables that failed during replication instead of restarting the replication.</p> <p>The <code>resume-processing</code> option isn't applicable for a full-load replication, because you can't resume partially loaded tables during the full load phase.</p> <p>For a <code>full-load-and-cdc</code> replication, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use <code>reload-target</code>. Otherwise use <code>resume-processing</code>, to replicate the changes from the last stop position.</p>" }, + "PremigrationAssessmentSettings":{ + "shape":"String", + "documentation":"<p>User-defined settings for the premigration assessment. The possible values are:</p> <ul> <li> <p> <code>ResultLocationFinder</code>: The folder within an Amazon Amazon S3 bucket where you want DMS to store the results of this assessment run.</p> </li> <li> <p> <code>ResultEncryptionMode</code>: The supported values are <code>SSE_KMS</code> and <code>SSE_S3</code>. If these values are not provided, then the files are not encrypted at rest. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.KMSKeys\">Creating Amazon Web Services KMS keys to encrypt Amazon Amazon S3 target objects</a>.</p> </li> <li> <p> <code>ResultKmsKeyArn</code>: The ARN of a customer KMS encryption key that you specify when you set <code>ResultEncryptionMode</code> to <code>SSE_KMS</code>.</p> </li> <li> <p> <code>IncludeOnly</code>: A space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that Database Migration Service supports for the associated migration.</p> </li> <li> <p> <code>Exclude</code>: A space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that Database Migration Service supports for the associated migration.</p> </li> <li> <p> <code>FailOnAssessmentFailure</code>: A configurable setting you can set to <code>true</code> (the default setting) or <code>false</code>. Use this setting to to stop the replication from starting automatically if the assessment fails. This can help you evaluate the issue that is preventing the replication from running successfully.</p> </li> </ul>" + }, "CdcStartTime":{ "shape":"TStamp", "documentation":"<p>Indicates the start time for a change data capture (CDC) operation. Use either <code>CdcStartTime</code> or <code>CdcStartPosition</code> to specify when you want a CDC operation to start. Specifying both values results in an error.</p>" @@ -10175,6 +10307,14 @@ "type":"list", "member":{"shape":"TableToReload"} }, + "TablePreparationMode":{ + "type":"string", + "enum":[ + "do-nothing", + "truncate", + "drop-tables-on-target" + ] + }, "TableStatistics":{ "type":"structure", "members":{ @@ -10317,6 +10457,20 @@ "type":"list", "member":{"shape":"Tag"} }, + "TargetDataSetting":{ + "type":"structure", + "members":{ + "TablePreparationMode":{ + "shape":"TablePreparationMode", + "documentation":"<p>This setting determines how DMS handles the target tables before starting a data migration, either by leaving them untouched, dropping and recreating them, or truncating the existing data in the target tables.</p>" + } + }, + "documentation":"<p>Defines settings for a target data provider for a data migration.</p>" + }, + "TargetDataSettings":{ + "type":"list", + "member":{"shape":"TargetDataSetting"} + }, "TargetDbType":{ "type":"string", "enum":[ diff --git a/contrib/python/botocore/py3/botocore/data/ec2/2016-11-15/service-2.json b/contrib/python/botocore/py3/botocore/data/ec2/2016-11-15/service-2.json index 547df916462..8f67266c165 100644 --- a/contrib/python/botocore/py3/botocore/data/ec2/2016-11-15/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/ec2/2016-11-15/service-2.json @@ -152,7 +152,7 @@ }, "input":{"shape":"AssignIpv6AddressesRequest"}, "output":{"shape":"AssignIpv6AddressesResult"}, - "documentation":"<p>Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type.</p> <p>You must specify either the IPv6 addresses or the IPv6 address count in the request. </p> <p>You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html\"> Assigning prefixes to network interfaces</a> in the <i>Amazon EC2 User Guide</i>.</p>" + "documentation":"<p>Assigns the specified IPv6 addresses to the specified network interface. You can specify specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies by instance type.</p> <p>You must specify either the IPv6 addresses or the IPv6 address count in the request. </p> <p>You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html\"> Assigning prefixes to network interfaces</a> in the <i>Amazon EC2 User Guide</i>.</p>" }, "AssignPrivateIpAddresses":{ "name":"AssignPrivateIpAddresses", @@ -162,7 +162,7 @@ }, "input":{"shape":"AssignPrivateIpAddressesRequest"}, "output":{"shape":"AssignPrivateIpAddressesResult"}, - "documentation":"<p>Assigns one or more secondary private IP addresses to the specified network interface.</p> <p>You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html\">Elastic IP Addresses</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.</p> <p>Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check <code>network/interfaces/macs/mac/local-ipv4s</code> in the instance metadata to confirm that the remapping is complete.</p> <p>You must specify either the IP addresses or the IP address count in the request.</p> <p>You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html\"> Assigning prefixes to network interfaces</a> in the <i>Amazon EC2 User Guide</i>.</p>" + "documentation":"<p>Assigns the specified secondary private IP addresses to the specified network interface.</p> <p>You can specify specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned from the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html\">Elastic IP Addresses</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.</p> <p>Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check <code>network/interfaces/macs/mac/local-ipv4s</code> in the instance metadata to confirm that the remapping is complete.</p> <p>You must specify either the IP addresses or the IP address count in the request.</p> <p>You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html\"> Assigning prefixes to network interfaces</a> in the <i>Amazon EC2 User Guide</i>.</p>" }, "AssignPrivateNatGatewayAddress":{ "name":"AssignPrivateNatGatewayAddress", @@ -938,7 +938,7 @@ }, "input":{"shape":"CreateManagedPrefixListRequest"}, "output":{"shape":"CreateManagedPrefixListResult"}, - "documentation":"<p>Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.</p>" + "documentation":"<p>Creates a managed prefix list. You can specify entries for the prefix list. Each entry consists of a CIDR block and an optional description.</p>" }, "CreateNatGateway":{ "name":"CreateNatGateway", @@ -2766,7 +2766,7 @@ }, "input":{"shape":"DescribeInstanceAttributeRequest"}, "output":{"shape":"InstanceAttribute"}, - "documentation":"<p>Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: <code>instanceType</code> | <code>kernel</code> | <code>ramdisk</code> | <code>userData</code> | <code>disableApiTermination</code> | <code>instanceInitiatedShutdownBehavior</code> | <code>rootDeviceName</code> | <code>blockDeviceMapping</code> | <code>productCodes</code> | <code>sourceDestCheck</code> | <code>groupSet</code> | <code>ebsOptimized</code> | <code>sriovNetSupport</code> </p>" + "documentation":"<p>Describes the specified attribute of the specified instance. You can specify only one attribute at a time. </p>" }, "DescribeInstanceConnectEndpoints":{ "name":"DescribeInstanceConnectEndpoints", @@ -3176,7 +3176,7 @@ }, "input":{"shape":"DescribeNetworkInterfacesRequest"}, "output":{"shape":"DescribeNetworkInterfacesResult"}, - "documentation":"<p>Describes one or more of your network interfaces.</p> <p>If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: <code>group-id</code>, <code>mac-address</code>, <code>private-dns-name</code>, <code>private-ip-address</code>, <code>private-dns-name</code>, <code>subnet-id</code>, or <code>vpc-id</code>.</p> <important> <p>We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.</p> </important>" + "documentation":"<p>Describes the specified network interfaces or all your network interfaces.</p> <p>If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: <code>group-id</code>, <code>mac-address</code>, <code>private-dns-name</code>, <code>private-ip-address</code>, <code>private-dns-name</code>, <code>subnet-id</code>, or <code>vpc-id</code>.</p> <important> <p>We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts.</p> </important>" }, "DescribePlacementGroups":{ "name":"DescribePlacementGroups", @@ -6469,7 +6469,7 @@ }, "input":{"shape":"UnassignIpv6AddressesRequest"}, "output":{"shape":"UnassignIpv6AddressesResult"}, - "documentation":"<p>Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.</p>" + "documentation":"<p>Unassigns the specified IPv6 addresses or Prefix Delegation prefixes from a network interface.</p>" }, "UnassignPrivateIpAddresses":{ "name":"UnassignPrivateIpAddresses", @@ -6478,7 +6478,7 @@ "requestUri":"/" }, "input":{"shape":"UnassignPrivateIpAddressesRequest"}, - "documentation":"<p>Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.</p>" + "documentation":"<p>Unassigns the specified secondary private IP addresses or IPv4 Prefix Delegation prefixes from a network interface.</p>" }, "UnassignPrivateNatGatewayAddress":{ "name":"UnassignPrivateNatGatewayAddress", @@ -7676,7 +7676,10 @@ }, "AllocationType":{ "type":"string", - "enum":["used"] + "enum":[ + "used", + "future" + ] }, "AllowedImagesSettingsDisabledState":{ "type":"string", @@ -8211,7 +8214,7 @@ }, "Ipv6Prefixes":{ "shape":"IpPrefixList", - "documentation":"<p>One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the <code>Ipv6PrefixCount</code> option.</p>", + "documentation":"<p>One or more IPv6 prefixes assigned to the network interface. You can't use this option if you use the <code>Ipv6PrefixCount</code> option.</p>", "locationName":"Ipv6Prefix" }, "NetworkInterfaceId":{ @@ -8257,12 +8260,12 @@ "members":{ "Ipv4Prefixes":{ "shape":"IpPrefixList", - "documentation":"<p>One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the <code>Ipv4PrefixCount</code> option.</p>", + "documentation":"<p>One or more IPv4 prefixes assigned to the network interface. You can't use this option if you use the <code>Ipv4PrefixCount</code> option.</p>", "locationName":"Ipv4Prefix" }, "Ipv4PrefixCount":{ "shape":"Integer", - "documentation":"<p>The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the <code>Ipv4 Prefixes</code> option.</p>" + "documentation":"<p>The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You can't use this option if you use the <code>Ipv4 Prefixes</code> option.</p>" }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", @@ -9654,7 +9657,7 @@ "members":{ "CidrIp":{ "shape":"String", - "documentation":"<p>The IPv4 address range, in CIDR format.</p> <p>To specify an IPv6 address range, use IP permissions instead.</p> <p>To specify multiple rules and descriptions for the rules, use IP permissions instead.</p>" + "documentation":"<p>The IPv4 address range, in CIDR format.</p> <note> <p> Amazon Web Services <a href=\"https://en.wikipedia.org/wiki/Canonicalization\">canonicalizes</a> IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error.</p> </note> <p>To specify an IPv6 address range, use IP permissions instead.</p> <p>To specify multiple rules and descriptions for the rules, use IP permissions instead.</p>" }, "FromPort":{ "shape":"Integer", @@ -9767,7 +9770,7 @@ }, "GroupName":{ "shape":"String", - "documentation":"<p> For Availability Zones, this parameter has the same value as the Region name.</p> <p>For Local Zones, the name of the associated group, for example <code>us-west-2-lax-1</code>.</p> <p>For Wavelength Zones, the name of the associated group, for example <code>us-east-1-wl1-bos-wlz-1</code>.</p>", + "documentation":"<p>The name of the zone group. For example:</p> <ul> <li> <p>Availability Zones - <code>us-east-1-zg-1</code> </p> </li> <li> <p>Local Zones - <code>us-west-2-lax-1</code> </p> </li> <li> <p>Wavelength Zones - <code>us-east-1-wl1-bos-wlz-1</code> </p> </li> </ul>", "locationName":"groupName" }, "NetworkBorderGroup":{ @@ -13229,7 +13232,7 @@ }, "InstanceCount":{ "shape":"Integer", - "documentation":"<p>The number of instances for which to reserve capacity.</p> <note> <p>You can request future-dated Capacity Reservations for an instance count with a minimum of 100 VPUs. For example, if you request a future-dated Capacity Reservation for <code>m5.xlarge</code> instances, you must request at least 25 instances (<i>25 * m5.xlarge = 100 vCPUs</i>).</p> </note> <p>Valid range: 1 - 1000</p>" + "documentation":"<p>The number of instances for which to reserve capacity.</p> <note> <p>You can request future-dated Capacity Reservations for an instance count with a minimum of 100 vCPUs. For example, if you request a future-dated Capacity Reservation for <code>m5.xlarge</code> instances, you must request at least 25 instances (<i>25 * m5.xlarge = 100 vCPUs</i>).</p> </note> <p>Valid range: 1 - 1000</p>" }, "EbsOptimized":{ "shape":"Boolean", @@ -13797,7 +13800,8 @@ }, "ClientToken":{ "shape":"String", - "documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring idempotency</a>.</p>" + "documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring idempotency</a>.</p>", + "idempotencyToken":true }, "SpotOptions":{ "shape":"SpotOptionsRequest", @@ -15177,7 +15181,7 @@ }, "Groups":{ "shape":"SecurityGroupIdStringList", - "documentation":"<p>The IDs of one or more security groups.</p>", + "documentation":"<p>The IDs of the security groups.</p>", "locationName":"SecurityGroupId" }, "PrivateIpAddresses":{ @@ -20392,7 +20396,7 @@ }, "Filters":{ "shape":"FilterList", - "documentation":"<p>The filters.</p> <ul> <li> <p> <code>group-name</code> - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, <code>us-west-2-lax-1</code>) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, <code>us-east-1-wl1</code>).</p> </li> <li> <p> <code>message</code> - The Zone message.</p> </li> <li> <p> <code>opt-in-status</code> - The opt-in status (<code>opted-in</code> | <code>not-opted-in</code> | <code>opt-in-not-required</code>).</p> </li> <li> <p> <code>parent-zone-id</code> - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.</p> </li> <li> <p> <code>parent-zone-name</code> - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.</p> </li> <li> <p> <code>region-name</code> - The name of the Region for the Zone (for example, <code>us-east-1</code>).</p> </li> <li> <p> <code>state</code> - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (<code>available</code>).</p> </li> <li> <p> <code>zone-id</code> - The ID of the Availability Zone (for example, <code>use1-az1</code>), the Local Zone (for example, <code>usw2-lax1-az1</code>), or the Wavelength Zone (for example, <code>us-east-1-wl1-bos-wlz-1</code>).</p> </li> <li> <p> <code>zone-name</code> - The name of the Availability Zone (for example, <code>us-east-1a</code>), the Local Zone (for example, <code>us-west-2-lax-1a</code>), or the Wavelength Zone (for example, <code>us-east-1-wl1-bos-wlz-1</code>).</p> </li> <li> <p> <code>zone-type</code> - The type of zone (<code>availability-zone</code> | <code>local-zone</code> | <code>wavelength-zone</code>).</p> </li> </ul>", + "documentation":"<p>The filters.</p> <ul> <li> <p> <code>group-name</code> - The name of the zone group for the Availability Zone (for example, <code>us-east-1-zg-1</code>), the Local Zone (for example, <code>us-west-2-lax-1</code>), or the Wavelength Zone (for example, <code>us-east-1-wl1</code>).</p> </li> <li> <p> <code>message</code> - The Zone message.</p> </li> <li> <p> <code>opt-in-status</code> - The opt-in status (<code>opted-in</code> | <code>not-opted-in</code> | <code>opt-in-not-required</code>).</p> </li> <li> <p> <code>parent-zone-id</code> - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.</p> </li> <li> <p> <code>parent-zone-name</code> - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.</p> </li> <li> <p> <code>region-name</code> - The name of the Region for the Zone (for example, <code>us-east-1</code>).</p> </li> <li> <p> <code>state</code> - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (<code>available</code>).</p> </li> <li> <p> <code>zone-id</code> - The ID of the Availability Zone (for example, <code>use1-az1</code>), the Local Zone (for example, <code>usw2-lax1-az1</code>), or the Wavelength Zone (for example, <code>us-east-1-wl1-bos-wlz-1</code>).</p> </li> <li> <p> <code>zone-name</code> - The name of the Availability Zone (for example, <code>us-east-1a</code>), the Local Zone (for example, <code>us-west-2-lax-1a</code>), or the Wavelength Zone (for example, <code>us-east-1-wl1-bos-wlz-1</code>).</p> </li> <li> <p> <code>zone-type</code> - The type of zone (<code>availability-zone</code> | <code>local-zone</code> | <code>wavelength-zone</code>).</p> </li> </ul>", "locationName":"Filter" } } @@ -22465,7 +22469,7 @@ }, "Attribute":{ "shape":"InstanceAttributeName", - "documentation":"<p>The instance attribute.</p> <p>Note: The <code>enaSupport</code> attribute is not supported at this time.</p>", + "documentation":"<p>The instance attribute.</p> <p>Note that the <code>enaSupport</code> attribute is not supported.</p>", "locationName":"attribute" } } @@ -27197,7 +27201,7 @@ }, "Filters":{ "shape":"FilterList", - "documentation":"<p>The filters.</p> <ul> <li> <p> <code>ip-address-type</code> - The IP address type (<code>ipv4</code> | <code>ipv6</code>).</p> </li> <li> <p> <code>service-name</code> - The name of the service.</p> </li> <li> <p> <code>service-region</code> - The Region of the service.</p> </li> <li> <p> <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p> </li> <li> <p> <code>vpc-id</code> - The ID of the VPC in which the endpoint resides.</p> </li> <li> <p> <code>vpc-endpoint-id</code> - The ID of the endpoint.</p> </li> <li> <p> <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | <code>rejected</code> | <code>failed</code>).</p> </li> <li> <p> <code>vpc-endpoint-type</code> - The type of VPC endpoint (<code>Interface</code> | <code>Gateway</code> | <code>GatewayLoadBalancer</code>).</p> </li> </ul>", + "documentation":"<p>The filters.</p> <ul> <li> <p> <code>ip-address-type</code> - The IP address type (<code>ipv4</code> | <code>ipv6</code>).</p> </li> <li> <p> <code>service-name</code> - The name of the service.</p> </li> <li> <p> <code>service-region</code> - The Region of the service.</p> </li> <li> <p> <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p> </li> <li> <p> <code>vpc-id</code> - The ID of the VPC in which the endpoint resides.</p> </li> <li> <p> <code>vpc-endpoint-id</code> - The ID of the endpoint.</p> </li> <li> <p> <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | <code>rejected</code> | <code>failed</code>).</p> </li> <li> <p> <code>vpc-endpoint-type</code> - The type of VPC endpoint (<code>Interface</code> | <code>Gateway</code> | <code>GatewayLoadBalancer</code> | <code>Resource</code> | <code>ServiceNetwork</code>).</p> </li> </ul>", "locationName":"Filter" }, "MaxResults":{ @@ -30478,7 +30482,7 @@ }, "EventSubType":{ "shape":"String", - "documentation":"<p>The event.</p> <p> <code>error</code> events:</p> <ul> <li> <p> <code>iamFleetRoleInvalid</code> - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.</p> </li> <li> <p> <code>allLaunchSpecsTemporarilyBlacklisted</code> - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.</p> </li> <li> <p> <code>spotInstanceCountLimitExceeded</code> - You've reached the limit on the number of Spot Instances that you can launch.</p> </li> <li> <p> <code>spotFleetRequestConfigurationInvalid</code> - The configuration is not valid. For more information, see the description of the event.</p> </li> </ul> <p> <code>fleetRequestChange</code> events:</p> <ul> <li> <p> <code>active</code> - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.</p> </li> <li> <p> <code>deleted</code> (EC2 Fleet) / <code>cancelled</code> (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.</p> </li> <li> <p> <code>deleted_running</code> (EC2 Fleet) / <code>cancelled_running</code> (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.</p> </li> <li> <p> <code>deleted_terminating</code> (EC2 Fleet) / <code>cancelled_terminating</code> (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.</p> </li> <li> <p> <code>expired</code> - The EC2 Fleet or Spot Fleet request has expired. If the request was created with <code>TerminateInstancesWithExpiration</code> set, a subsequent <code>terminated</code> event indicates that the instances are terminated.</p> </li> <li> <p> <code>modify_in_progress</code> - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.</p> </li> <li> <p> <code>modify_succeeded</code> - The EC2 Fleet or Spot Fleet request was modified.</p> </li> <li> <p> <code>submitted</code> - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.</p> </li> <li> <p> <code>progress</code> - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.</p> </li> </ul> <p> <code>instanceChange</code> events:</p> <ul> <li> <p> <code>launched</code> - A new instance was launched.</p> </li> <li> <p> <code>terminated</code> - An instance was terminated by the user.</p> </li> <li> <p> <code>termination_notified</code> - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.</p> </li> </ul> <p> <code>Information</code> events:</p> <ul> <li> <p> <code>fleetProgressHalted</code> - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced <code>launchSpecUnusable</code> events). A launch specification might become valid if the Spot price changes.</p> </li> <li> <p> <code>launchSpecTemporarilyBlacklisted</code> - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.</p> </li> <li> <p> <code>launchSpecUnusable</code> - The price in a launch specification is not valid because it is below the Spot price.</p> </li> <li> <p> <code>registerWithLoadBalancersFailed</code> - An attempt to register instances with load balancers failed. For more information, see the description of the event.</p> </li> </ul>", + "documentation":"<p>The event.</p> <p> <code>error</code> events:</p> <ul> <li> <p> <code>iamFleetRoleInvalid</code> - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.</p> </li> <li> <p> <code>allLaunchSpecsTemporarilyBlacklisted</code> - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.</p> </li> <li> <p> <code>spotInstanceCountLimitExceeded</code> - You've reached the limit on the number of Spot Instances that you can launch.</p> </li> <li> <p> <code>spotFleetRequestConfigurationInvalid</code> - The configuration is not valid. For more information, see the description of the event.</p> </li> </ul> <p> <code>fleetRequestChange</code> events:</p> <ul> <li> <p> <code>active</code> - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.</p> </li> <li> <p> <code>deleted</code> (EC2 Fleet) / <code>cancelled</code> (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.</p> </li> <li> <p> <code>deleted_running</code> (EC2 Fleet) / <code>cancelled_running</code> (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.</p> </li> <li> <p> <code>deleted_terminating</code> (EC2 Fleet) / <code>cancelled_terminating</code> (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.</p> </li> <li> <p> <code>expired</code> - The EC2 Fleet or Spot Fleet request has expired. If the request was created with <code>TerminateInstancesWithExpiration</code> set, a subsequent <code>terminated</code> event indicates that the instances are terminated.</p> </li> <li> <p> <code>modify_in_progress</code> - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.</p> </li> <li> <p> <code>modify_succeeded</code> - The EC2 Fleet or Spot Fleet request was modified.</p> </li> <li> <p> <code>submitted</code> - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.</p> </li> <li> <p> <code>progress</code> - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.</p> </li> </ul> <p> <code>instanceChange</code> events:</p> <ul> <li> <p> <code>launched</code> - A new instance was launched.</p> </li> <li> <p> <code>terminated</code> - An instance was terminated by the user.</p> </li> <li> <p> <code>termination_notified</code> - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.</p> </li> </ul> <p> <code>Information</code> events:</p> <ul> <li> <p> <code>fleetProgressHalted</code> - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced <code>launchSpecUnusable</code> events). A launch specification might become valid if the Spot price changes.</p> </li> <li> <p> <code>launchSpecTemporarilyBlacklisted</code> - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.</p> </li> <li> <p> <code>launchSpecUnusable</code> - The price specified in a launch specification is not valid because it is below the Spot price for the requested Spot pools.</p> <p>Note: Even if a fleet with the <code>maintain</code> request type is in the process of being canceled, it may still publish a <code>launchSpecUnusable</code> event. This does not mean that the canceled fleet is attempting to launch a new instance.</p> </li> <li> <p> <code>registerWithLoadBalancersFailed</code> - An attempt to register instances with load balancers failed. For more information, see the description of the event.</p> </li> </ul>", "locationName":"eventSubType" }, "InstanceId":{ @@ -36947,7 +36951,7 @@ }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", - "documentation":"<p>If the value is <code>true</code>, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.</p>", + "documentation":"<p>Indicates whether termination protection is enabled. If the value is <code>true</code>, you can't terminate the instance using the Amazon EC2 console, command line tools, or API.</p>", "locationName":"disableApiTermination" }, "EnaSupport":{ @@ -36957,7 +36961,7 @@ }, "EnclaveOptions":{ "shape":"EnclaveOptions", - "documentation":"<p>To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to <code>true</code>; otherwise, set it to <code>false</code>.</p>", + "documentation":"<p>Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.</p>", "locationName":"enclaveOptions" }, "EbsOptimized":{ @@ -36987,7 +36991,7 @@ }, "ProductCodes":{ "shape":"ProductCodeList", - "documentation":"<p>A list of product codes.</p>", + "documentation":"<p>The product codes.</p>", "locationName":"productCodes" }, "RamdiskId":{ @@ -37002,7 +37006,7 @@ }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", - "documentation":"<p>Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is <code>true</code>, source/destination checks are enabled; otherwise, they are disabled. The default value is <code>true</code>. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.</p>", + "documentation":"<p>Indicates whether source/destination checks are enabled.</p>", "locationName":"sourceDestCheck" }, "SriovNetSupport":{ @@ -37017,7 +37021,7 @@ }, "DisableApiStop":{ "shape":"AttributeBooleanValue", - "documentation":"<p>To enable the instance for Amazon Web Services Stop Protection, set this parameter to <code>true</code>; otherwise, set it to <code>false</code>.</p>", + "documentation":"<p>Indicates whether stop protection is enabled for the instance.</p>", "locationName":"disableApiStop" }, "Groups":{ @@ -38319,7 +38323,7 @@ }, "AcceleratorTypes":{ "shape":"AcceleratorTypeSet", - "documentation":"<p>The accelerator types that must be on the instance type.</p> <ul> <li> <p>For instance types with GPU accelerators, specify <code>gpu</code>.</p> </li> <li> <p>For instance types with FPGA accelerators, specify <code>fpga</code>.</p> </li> </ul> <p>Default: Any accelerator type</p>", + "documentation":"<p>The accelerator types that must be on the instance type.</p> <ul> <li> <p>For instance types with FPGA accelerators, specify <code>fpga</code>.</p> </li> <li> <p>For instance types with GPU accelerators, specify <code>gpu</code>.</p> </li> <li> <p>For instance types with Inference accelerators, specify <code>inference</code>.</p> </li> </ul> <p>Default: Any accelerator type</p>", "locationName":"acceleratorTypeSet" }, "AcceleratorCount":{ @@ -38442,7 +38446,7 @@ }, "AcceleratorTypes":{ "shape":"AcceleratorTypeSet", - "documentation":"<p>The accelerator types that must be on the instance type.</p> <ul> <li> <p>To include instance types with GPU hardware, specify <code>gpu</code>.</p> </li> <li> <p>To include instance types with FPGA hardware, specify <code>fpga</code>.</p> </li> </ul> <p>Default: Any accelerator type</p>", + "documentation":"<p>The accelerator types that must be on the instance type.</p> <ul> <li> <p>For instance types with FPGA accelerators, specify <code>fpga</code>.</p> </li> <li> <p>For instance types with GPU accelerators, specify <code>gpu</code>.</p> </li> <li> <p>For instance types with Inference accelerators, specify <code>inference</code>.</p> </li> </ul> <p>Default: Any accelerator type</p>", "locationName":"AcceleratorType" }, "AcceleratorCount":{ @@ -39707,7 +39711,15 @@ "i8g.12xlarge", "i8g.16xlarge", "i8g.24xlarge", - "i8g.metal-24xl" + "i8g.metal-24xl", + "u7i-6tb.112xlarge", + "u7i-8tb.112xlarge", + "u7inh-32tb.480xlarge", + "p5e.48xlarge", + "p5en.48xlarge", + "f2.12xlarge", + "f2.48xlarge", + "trn2.48xlarge" ] }, "InstanceTypeHypervisor":{ @@ -40168,7 +40180,7 @@ }, "CidrIp":{ "shape":"String", - "documentation":"<p>The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.</p>", + "documentation":"<p>The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.</p> <note> <p> Amazon Web Services <a href=\"https://en.wikipedia.org/wiki/Canonicalization\">canonicalizes</a> IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error.</p> </note>", "locationName":"cidrIp" } }, @@ -41874,7 +41886,7 @@ "documentation":"<p>The IPv6 prefix.</p>" } }, - "documentation":"<p>Describes the IPv4 prefix option for a network interface.</p>" + "documentation":"<p>Describes the IPv6 prefix option for a network interface.</p>" }, "Ipv6PrefixSpecificationResponse":{ "type":"structure", @@ -41904,7 +41916,7 @@ }, "CidrIpv6":{ "shape":"String", - "documentation":"<p>The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.</p>", + "documentation":"<p>The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.</p> <note> <p> Amazon Web Services <a href=\"https://en.wikipedia.org/wiki/Canonicalization\">canonicalizes</a> IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error.</p> </note>", "locationName":"cidrIpv6" } }, @@ -45245,7 +45257,7 @@ }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", - "documentation":"<p>If the value is <code>true</code>, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.</p>", + "documentation":"<p>Enable or disable termination protection for the instance. If the value is <code>true</code>, you can't terminate the instance using the Amazon EC2 console, command line interface, or API. You can't enable termination protection for Spot Instances.</p>", "locationName":"disableApiTermination" }, "InstanceType":{ @@ -45856,12 +45868,12 @@ }, "AddOrganizationalUnitExclusions":{ "shape":"AddIpamOrganizationalUnitExclusionSet", - "documentation":"<p>Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html\">Quotas for your IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>", + "documentation":"<p>Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html\">Quotas for your IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> <note> <p>The resulting set of exclusions must not result in \"overlap\", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process in <a href=\"https://docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html#exclude-ous-create-delete\">Add or remove OU exclusions </a> in the <i>Amazon VPC User Guide</i>.</p> </note>", "locationName":"AddOrganizationalUnitExclusion" }, "RemoveOrganizationalUnitExclusions":{ "shape":"RemoveIpamOrganizationalUnitExclusionSet", - "documentation":"<p>Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html\">Quotas for your IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>", + "documentation":"<p>Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html\">Quotas for your IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</p> <note> <p>The resulting set of exclusions must not result in \"overlap\", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the Amazon Web Services CLI request process in <a href=\"https://docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html#exclude-ous-create-delete\">Add or remove OU exclusions </a> in the <i>Amazon VPC User Guide</i>.</p> </note>", "locationName":"RemoveOrganizationalUnitExclusion" } } @@ -53075,7 +53087,7 @@ }, "DisableApiTermination":{ "shape":"Boolean", - "documentation":"<p>If you set this parameter to <code>true</code>, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html\">ModifyInstanceAttribute</a>. Alternatively, if you set <code>InstanceInitiatedShutdownBehavior</code> to <code>terminate</code>, you can terminate the instance by running the shutdown command from the instance.</p>" + "documentation":"<p>Indicates whether termination protection is enabled for the instance. The default is <code>false</code>, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.</p>" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", @@ -55452,7 +55464,7 @@ }, "DisableApiTermination":{ "shape":"Boolean", - "documentation":"<p>If you set this parameter to <code>true</code>, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html\">ModifyInstanceAttribute</a>. Alternatively, if you set <code>InstanceInitiatedShutdownBehavior</code> to <code>terminate</code>, you can terminate the instance by running the shutdown command from the instance.</p> <p>Default: <code>false</code> </p>", + "documentation":"<p>Indicates whether termination protection is enabled for the instance. The default is <code>false</code>, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.</p>", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ @@ -56566,7 +56578,7 @@ "documentation":"<p>The description of the security group rule.</p>" } }, - "documentation":"<p>Describes a security group rule.</p> <p>You must specify exactly one of the following parameters, based on the rule type:</p> <ul> <li> <p>CidrIpv4</p> </li> <li> <p>CidrIpv6</p> </li> <li> <p>PrefixListId</p> </li> <li> <p>ReferencedGroupId</p> </li> </ul> <p>When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use <code>CidrIpv4</code> to specify a new IPv4 address range.</p>" + "documentation":"<p>Describes a security group rule.</p> <p>You must specify exactly one of the following parameters, based on the rule type:</p> <ul> <li> <p>CidrIpv4</p> </li> <li> <p>CidrIpv6</p> </li> <li> <p>PrefixListId</p> </li> <li> <p>ReferencedGroupId</p> </li> </ul> <note> <p> Amazon Web Services <a href=\"https://en.wikipedia.org/wiki/Canonicalization\">canonicalizes</a> IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error.</p> </note> <p>When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use <code>CidrIpv4</code> to specify a new IPv4 address range.</p>" }, "SecurityGroupRuleUpdate":{ "type":"structure", @@ -57002,6 +57014,11 @@ "documentation":"<p>The time stamp when the snapshot was completed.</p>", "locationName":"completionTime" }, + "FullSnapshotSizeInBytes":{ + "shape":"Long", + "documentation":"<p>The full size of the snapshot, in bytes.</p> <important> <p>This is <b>not</b> the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created.</p> </important>", + "locationName":"fullSnapshotSizeInBytes" + }, "SnapshotId":{ "shape":"String", "documentation":"<p>The ID of the snapshot. Each snapshot receives a unique identifier when it is created.</p>", @@ -57274,7 +57291,7 @@ }, "RecycleBinEnterTime":{ "shape":"MillisecondDateTime", - "documentation":"<p>The date and time when the snaphsot entered the Recycle Bin.</p>", + "documentation":"<p>The date and time when the snapshot entered the Recycle Bin.</p>", "locationName":"recycleBinEnterTime" }, "RecycleBinExitTime":{ @@ -58024,7 +58041,7 @@ "members":{ "MaxPrice":{ "shape":"String", - "documentation":"<p>The maximum hourly price that you're willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.</p> <important> <p>If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.</p> </important>" + "documentation":"<p>The maximum hourly price that you're willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.</p> <important> <p>If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.</p> <p>If you specify a maximum price, it must be more than USD $0.001. Specifying a value below USD $0.001 will result in an <code>InvalidParameterValue</code> error message.</p> </important>" }, "SpotInstanceType":{ "shape":"SpotInstanceType", @@ -61959,7 +61976,7 @@ }, "UnassignedIpv6Prefixes":{ "shape":"IpPrefixList", - "documentation":"<p>The IPv4 prefixes that have been unassigned from the network interface.</p>", + "documentation":"<p>The IPv6 prefixes that have been unassigned from the network interface.</p>", "locationName":"unassignedIpv6PrefixSet" } } diff --git a/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/service-2.json b/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/service-2.json index e1ecff94327..f6a3e0d7af9 100644 --- a/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/ecr/2015-09-21/service-2.json @@ -703,7 +703,7 @@ {"shape":"ImageNotFoundException"}, {"shape":"ValidationException"} ], - "documentation":"<p>Starts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html\">Image scanning</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>" + "documentation":"<p>Starts a basic image vulnerability scan.</p> <p> A basic image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. You can start up to 100,000 basic scans per 24 hours. This limit includes both scans on initial push and scans initiated by the StartImageScan API. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning-basic.html\">Basic scanning</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>" }, "StartLifecyclePolicyPreview":{ "name":"StartLifecyclePolicyPreview", @@ -3836,7 +3836,8 @@ "ACTIVE", "PENDING", "SCAN_ELIGIBILITY_EXPIRED", - "FINDINGS_UNAVAILABLE" + "FINDINGS_UNAVAILABLE", + "LIMIT_EXCEEDED" ] }, "ScanStatusDescription":{"type":"string"}, diff --git a/contrib/python/botocore/py3/botocore/data/ecs/2014-11-13/service-2.json b/contrib/python/botocore/py3/botocore/data/ecs/2014-11-13/service-2.json index 148e12ec180..bea65939a27 100644 --- a/contrib/python/botocore/py3/botocore/data/ecs/2014-11-13/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/ecs/2014-11-13/service-2.json @@ -1197,7 +1197,7 @@ }, "assignPublicIp":{ "shape":"AssignPublicIp", - "documentation":"<p>Whether the task's elastic network interface receives a public IP address. The default value is <code>ENABLED</code>.</p>" + "documentation":"<p>Whether the task's elastic network interface receives a public IP address. </p> <p>Consider the following when you set this value:</p> <ul> <li> <p>When you use <code>create-service</code> or <code>update-service</code>, the default is <code>DISABLED</code>. </p> </li> <li> <p>When the service <code>deploymentController</code> is <code>ECS</code>, the value must be <code>DISABLED</code>. </p> </li> <li> <p>When you use <code>create-service</code> or <code>update-service</code>, the default is <code>ENABLED</code>. </p> </li> </ul>" } }, "documentation":"<p>An object representing the networking details for a task or service. For example <code>awsVpcConfiguration={subnets=[\"subnet-12344321\"],securityGroups=[\"sg-12344321\"]}</code>.</p>" @@ -1206,7 +1206,7 @@ "type":"structure", "members":{ }, - "documentation":"<p>Your Amazon Web Services account was blocked. For more information, contact <a href=\"http://aws.amazon.com/contact-us/\"> Amazon Web Services Support</a>.</p>", + "documentation":"<p>Your Amazon Web Services account was blocked. For more information, contact <a href=\"http://aws.amazon.com/contact-us/\"> Amazon Web ServicesSupport</a>.</p>", "exception":true }, "Boolean":{"type":"boolean"}, @@ -1688,7 +1688,7 @@ }, "linuxParameters":{ "shape":"LinuxParameters", - "documentation":"<p>Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html\">KernelCapabilities</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>" + "documentation":"<p>Linux-specific modifications that are applied to the default Docker container configuration, such as Linux kernel capabilities. For more information see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html\">KernelCapabilities</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>" }, "secrets":{ "shape":"SecretList", @@ -2151,7 +2151,7 @@ }, "availabilityZoneRebalancing":{ "shape":"AvailabilityZoneRebalancing", - "documentation":"<p>Indicates whether to use Availability Zone rebalancing for the service.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html\">Balancing an Amazon ECS service across Availability Zones</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>" + "documentation":"<p>Indicates whether to use Availability Zone rebalancing for the service.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html\">Balancing an Amazon ECS service across Availability Zones</a> in the <i> <i>Amazon Elastic Container Service Developer Guide</i> </i>.</p>" }, "loadBalancers":{ "shape":"LoadBalancers", @@ -3493,22 +3493,22 @@ }, "interval":{ "shape":"BoxedInteger", - "documentation":"<p>The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.</p>" + "documentation":"<p>The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. This value applies only when you specify a <code>command</code>. </p>" }, "timeout":{ "shape":"BoxedInteger", - "documentation":"<p>The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.</p>" + "documentation":"<p>The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5. This value applies only when you specify a <code>command</code>. </p>" }, "retries":{ "shape":"BoxedInteger", - "documentation":"<p>The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.</p>" + "documentation":"<p>The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3. This value applies only when you specify a <code>command</code>. </p>" }, "startPeriod":{ "shape":"BoxedInteger", - "documentation":"<p>The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the <code>startPeriod</code> is off.</p> <note> <p>If a health check succeeds within the <code>startPeriod</code>, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.</p> </note>" + "documentation":"<p>The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the <code>startPeriod</code> is off. This value applies only when you specify a <code>command</code>. </p> <note> <p>If a health check succeeds within the <code>startPeriod</code>, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.</p> </note>" } }, - "documentation":"<p>An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the <code>HEALTHCHECK</code> parameter of docker run.</p> <note> <p>The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.</p> </note> <p>You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.</p> <p>The health check is designed to make sure that your containers survive agent restarts, upgrades, or temporary unavailability.</p> <p>Amazon ECS performs health checks on containers with the default that launched the container instance or the task.</p> <p>The following describes the possible <code>healthStatus</code> values for a container:</p> <ul> <li> <p> <code>HEALTHY</code>-The container health check has passed successfully.</p> </li> <li> <p> <code>UNHEALTHY</code>-The container health check has failed.</p> </li> <li> <p> <code>UNKNOWN</code>-The container health check is being evaluated, there's no container health check defined, or Amazon ECS doesn't have the health status of the container.</p> </li> </ul> <p>The following describes the possible <code>healthStatus</code> values based on the container health checker status of essential containers in the task with the following priority order (high to low):</p> <ul> <li> <p> <code>UNHEALTHY</code>-One or more essential containers have failed their health check.</p> </li> <li> <p> <code>UNKNOWN</code>-Any essential container running within the task is in an <code>UNKNOWN</code> state and no other essential containers have an <code>UNHEALTHY</code> state.</p> </li> <li> <p> <code>HEALTHY</code>-All essential containers within the task have passed their health checks.</p> </li> </ul> <p>Consider the following task health example with 2 containers.</p> <ul> <li> <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>UNKNOWN</code>, the task health is <code>UNHEALTHY</code>.</p> </li> <li> <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>HEALTHY</code>, the task health is <code>UNHEALTHY</code>.</p> </li> <li> <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>UNKNOWN</code>, the task health is <code>UNKNOWN</code>.</p> </li> <li> <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>HEALTHY</code>, the task health is <code>HEALTHY</code>.</p> </li> </ul> <p>Consider the following task health example with 3 containers.</p> <ul> <li> <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3 is <code>UNKNOWN</code>, the task health is <code>UNHEALTHY</code>.</p> </li> <li> <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3 is <code>HEALTHY</code>, the task health is <code>UNHEALTHY</code>.</p> </li> <li> <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>HEALTHY</code>, and Container3 is <code>HEALTHY</code>, the task health is <code>UNHEALTHY</code>.</p> </li> <li> <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3 is <code>HEALTHY</code>, the task health is <code>UNKNOWN</code>.</p> </li> <li> <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3 is <code>UNKNOWN</code>, the task health is <code>UNKNOWN</code>.</p> </li> <li> <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>HEALTHY</code>, and Container3 is <code>HEALTHY</code>, the task health is <code>HEALTHY</code>.</p> </li> </ul> <p>If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.</p> <p>The following are notes about container health check support:</p> <ul> <li> <p>If the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this won't cause a container to transition to an <code>UNHEALTHY</code> status. This is by design, to ensure that containers remain running during agent restarts or temporary unavailability. The health check status is the \"last heard from\" response from the Amazon ECS agent, so if the container was considered <code>HEALTHY</code> prior to the disconnect, that status will remain until the agent reconnects and another health check occurs. There are no assumptions made about the status of the container health checks.</p> </li> <li> <p>Container health checks require version <code>1.17.0</code> or greater of the Amazon ECS container agent. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS container agent</a>.</p> </li> <li> <p>Container health checks are supported for Fargate tasks if you're using platform version <code>1.1.0</code> or greater. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">Fargate platform versions</a>.</p> </li> <li> <p>Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.</p> </li> </ul>" + "documentation":"<p>An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the <code>HEALTHCHECK</code> parameter of docker run.</p> <note> <p>The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.</p> </note> <p>You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.</p> <p>The health check is designed to make sure that your containers survive agent restarts, upgrades, or temporary unavailability.</p> <p>Amazon ECS performs health checks on containers with the default that launched the container instance or the task.</p> <p>The following describes the possible <code>healthStatus</code> values for a container:</p> <ul> <li> <p> <code>HEALTHY</code>-The container health check has passed successfully.</p> </li> <li> <p> <code>UNHEALTHY</code>-The container health check has failed.</p> </li> <li> <p> <code>UNKNOWN</code>-The container health check is being evaluated, there's no container health check defined, or Amazon ECS doesn't have the health status of the container.</p> </li> </ul> <p>The following describes the possible <code>healthStatus</code> values based on the container health checker status of essential containers in the task with the following priority order (high to low):</p> <ul> <li> <p> <code>UNHEALTHY</code>-One or more essential containers have failed their health check.</p> </li> <li> <p> <code>UNKNOWN</code>-Any essential container running within the task is in an <code>UNKNOWN</code> state and no other essential containers have an <code>UNHEALTHY</code> state.</p> </li> <li> <p> <code>HEALTHY</code>-All essential containers within the task have passed their health checks.</p> </li> </ul> <p>Consider the following task health example with 2 containers.</p> <ul> <li> <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>UNKNOWN</code>, the task health is <code>UNHEALTHY</code>.</p> </li> <li> <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>HEALTHY</code>, the task health is <code>UNHEALTHY</code>.</p> </li> <li> <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>UNKNOWN</code>, the task health is <code>UNKNOWN</code>.</p> </li> <li> <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>HEALTHY</code>, the task health is <code>HEALTHY</code>.</p> </li> </ul> <p>Consider the following task health example with 3 containers.</p> <ul> <li> <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3 is <code>UNKNOWN</code>, the task health is <code>UNHEALTHY</code>.</p> </li> <li> <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3 is <code>HEALTHY</code>, the task health is <code>UNHEALTHY</code>.</p> </li> <li> <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>HEALTHY</code>, and Container3 is <code>HEALTHY</code>, the task health is <code>UNHEALTHY</code>.</p> </li> <li> <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3 is <code>HEALTHY</code>, the task health is <code>UNKNOWN</code>.</p> </li> <li> <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3 is <code>UNKNOWN</code>, the task health is <code>UNKNOWN</code>.</p> </li> <li> <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>HEALTHY</code>, and Container3 is <code>HEALTHY</code>, the task health is <code>HEALTHY</code>.</p> </li> </ul> <p>If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.</p> <p>The following are notes about container health check support:</p> <ul> <li> <p>If the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this won't cause a container to transition to an <code>UNHEALTHY</code> status. This is by design, to ensure that containers remain running during agent restarts or temporary unavailability. The health check status is the \"last heard from\" response from the Amazon ECS agent, so if the container was considered <code>HEALTHY</code> prior to the disconnect, that status will remain until the agent reconnects and another health check occurs. There are no assumptions made about the status of the container health checks.</p> </li> <li> <p>Container health checks require version <code>1.17.0</code> or greater of the Amazon ECS container agent. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS container agent</a>.</p> </li> <li> <p>Container health checks are supported for Fargate tasks if you're using platform version <code>1.1.0</code> or greater. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">Fargate platform versions</a>.</p> </li> <li> <p>Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.</p> </li> </ul> <p>For an example of how to specify a task definition with multiple containers where container dependency is specified, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html#example_task_definition-containerdependency\">Container dependency</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>" }, "HealthStatus":{ "type":"string", @@ -3662,7 +3662,7 @@ "documentation":"<p>The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to <code>CapDrop</code> in the docker container create command and the <code>--cap-drop</code> option to docker run.</p> <p>Valid values: <code>\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"</code> </p>" } }, - "documentation":"<p>The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more detailed information about these Linux capabilities, see the <a href=\"http://man7.org/linux/man-pages/man7/capabilities.7.html\">capabilities(7)</a> Linux manual page.</p>" + "documentation":"<p>The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more detailed information about these Linux capabilities, see the <a href=\"http://man7.org/linux/man-pages/man7/capabilities.7.html\">capabilities(7)</a> Linux manual page.</p> <p>The following describes how Docker processes the Linux capabilities specified in the <code>add</code> and <code>drop</code> request parameters. For information about the latest behavior, see <a href=\"https://forums.docker.com/t/docker-compose-order-of-cap-drop-and-cap-add/97136/1\">Docker Compose: order of cap_drop and cap_add</a> in the Docker Community Forum.</p> <ul> <li> <p>When the container is a privleged container, the container capabilities are all of the default Docker capabilities. The capabilities specified in the <code>add</code> request parameter, and the <code>drop</code> request parameter are ignored.</p> </li> <li> <p>When the <code>add</code> request parameter is set to ALL, the container capabilities are all of the default Docker capabilities, excluding those specified in the <code>drop</code> request parameter.</p> </li> <li> <p>When the <code>drop</code> request parameter is set to ALL, the container capabilities are the capabilities specified in the <code>add</code> request parameter.</p> </li> <li> <p>When the <code>add</code> request parameter and the <code>drop</code> request parameter are both empty, the capabilities the container capabilities are all of the default Docker capabilities.</p> </li> <li> <p>The default is to first drop the capabilities specified in the <code>drop</code> request parameter, and then add the capabilities specified in the <code>add</code> request parameter.</p> </li> </ul>" }, "KeyValuePair":{ "type":"structure", @@ -4318,11 +4318,11 @@ "members":{ "kmsKeyId":{ "shape":"String", - "documentation":"<p>Specify a Key Management Service key ID to encrypt the managed storage.</p>" + "documentation":"<p>Specify a Key Management Service key ID to encrypt the managed storage.</p> <p>The key must be a single Region key.</p>" }, "fargateEphemeralStorageKmsKeyId":{ "shape":"String", - "documentation":"<p>Specify the Key Management Service key ID for the Fargate ephemeral storage.</p>" + "documentation":"<p>Specify the Key Management Service key ID for the Fargate ephemeral storage.</p> <p>The key must be a single Region key.</p>" } }, "documentation":"<p>The managed storage configuration for the cluster.</p>" @@ -4861,7 +4861,7 @@ }, "cpu":{ "shape":"String", - "documentation":"<p>The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, <code>1024</code>) or as a string using vCPUs (for example, <code>1 vCPU</code> or <code>1 vcpu</code>) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If you're using the EC2 launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>10240</code> CPU units (<code>10</code> vCPUs). If you do not specify a value, the parameter is ignored.</p> <p>If you're using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>memory</code> parameter:</p> <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> <li> <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> </ul>" + "documentation":"<p>The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, <code>1024</code>) or as a string using vCPUs (for example, <code>1 vCPU</code> or <code>1 vcpu</code>) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If you're using the EC2 launch type or external launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>196608</code> CPU units (<code>192</code> vCPUs). If you do not specify a value, the parameter is ignored.</p> <p>If you're using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>memory</code> parameter:</p> <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> <li> <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> </ul>" }, "memory":{ "shape":"String", @@ -5337,7 +5337,7 @@ }, "availabilityZoneRebalancing":{ "shape":"AvailabilityZoneRebalancing", - "documentation":"<p>Indicates whether to use Availability Zone rebalancing for the service.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html\">Balancing an Amazon ECS service across Availability Zones</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>" + "documentation":"<p>Indicates whether to use Availability Zone rebalancing for the service.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html\">Balancing an Amazon ECS service across Availability Zones</a> in the <i> <i>Amazon Elastic Container Service Developer Guide</i> </i>.</p>" } }, "documentation":"<p>Details on a service within a cluster.</p>" @@ -6048,7 +6048,7 @@ }, "task":{ "shape":"String", - "documentation":"<p>The task ID of the task to stop.</p>" + "documentation":"<p>Thefull Amazon Resource Name (ARN) of the task.</p>" }, "reason":{ "shape":"String", @@ -6249,7 +6249,7 @@ "members":{ "resourceArn":{ "shape":"String", - "documentation":"<p>The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.</p> <p>In order to tag a service that has the following ARN format, you need to migrate the service to the long ARN. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-arn-migration.html\">Migrate an Amazon ECS short service ARN to a long ARN</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p> <code>arn:aws:ecs:region:aws_account_id:service/service-name</code> </p> <p>After the migration is complete, the service has the long ARN format, as shown below. Use this ARN to tag the service.</p> <p> <code>arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name</code> </p> <p>If you try to tag a service with a short ARN, you receive an <code>InvalidParameterException</code> error.</p>" }, "tags":{ "shape":"Tags", @@ -6333,7 +6333,7 @@ }, "cpu":{ "shape":"String", - "documentation":"<p>The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, <code>1024</code>). It can also be expressed as a string using vCPUs (for example, <code>1 vCPU</code> or <code>1 vcpu</code>). String values are converted to an integer that indicates the CPU units when the task definition is registered.</p> <p>If you use the EC2 launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>10240</code> CPU units (<code>10</code> vCPUs).</p> <p>If you use the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the <code>memory</code> parameter:</p> <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> <li> <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> </ul>" + "documentation":"<p>The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units (for example, <code>1024</code>). It can also be expressed as a string using vCPUs (for example, <code>1 vCPU</code> or <code>1 vcpu</code>). String values are converted to an integer that indicates the CPU units when the task definition is registered.</p> <p>If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>196608</code> CPU units (<code>192</code> vCPUs). If you do not specify a value, the parameter is ignored.</p> <p>If you're using the Fargate launch type, this field is required. You must use one of the following values. These values determine the range of supported values for the <code>memory</code> parameter:</p> <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> <li> <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> </ul>" }, "createdAt":{ "shape":"Timestamp", @@ -6507,7 +6507,7 @@ }, "cpu":{ "shape":"String", - "documentation":"<p>The number of <code>cpu</code> units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the <code>memory</code> parameter.</p> <p>If you use the EC2 launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>10240</code> CPU units (<code>10</code> vCPUs).</p> <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> <li> <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> </ul>" + "documentation":"<p>The number of <code>cpu</code> units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the <code>memory</code> parameter.</p> <p>If you're using the EC2 launch type or the external launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>196608</code> CPU units (<code>192</code> vCPUs). </p> <p>If you're using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>memory</code> parameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> <li> <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p> <p>This option requires Linux platform <code>1.4.0</code> or later.</p> </li> </ul>" }, "memory":{ "shape":"String", @@ -7220,7 +7220,7 @@ }, "availabilityZoneRebalancing":{ "shape":"AvailabilityZoneRebalancing", - "documentation":"<p>Indicates whether to use Availability Zone rebalancing for the service.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html\">Balancing an Amazon ECS service across Availability Zones</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>" + "documentation":"<p>Indicates whether to use Availability Zone rebalancing for the service.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html\">Balancing an Amazon ECS service across Availability Zones</a> in the <i> <i>Amazon Elastic Container Service Developer Guide</i> </i>.</p>" }, "networkConfiguration":{ "shape":"NetworkConfiguration", diff --git a/contrib/python/botocore/py3/botocore/data/eks/2017-11-01/service-2.json b/contrib/python/botocore/py3/botocore/data/eks/2017-11-01/service-2.json index fb1e253d14b..d29fa61d8d7 100644 --- a/contrib/python/botocore/py3/botocore/data/eks/2017-11-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/eks/2017-11-01/service-2.json @@ -155,7 +155,7 @@ {"shape":"ResourceLimitExceededException"}, {"shape":"UnsupportedAvailabilityZoneException"} ], - "documentation":"<p>Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.</p> <p>The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.</p> <p>When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes <a href=\"https://kubernetes.io/docs/reference/access-authn-authz/rbac/\">Role Based Access Control</a> (RBAC) for authorization so that the <code>kubelet</code> that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html\">Pod Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p> <p>Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.</p> <p>If any Fargate profiles in a cluster are in the <code>DELETING</code> status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html\">Fargate profile</a> in the <i>Amazon EKS User Guide</i>.</p>" + "documentation":"<p>Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.</p> <p>The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile's selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.</p> <p>When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes <a href=\"https://kubernetes.io/docs/reference/access-authn-authz/rbac/\">Role Based Access Control</a> (RBAC) for authorization so that the <code>kubelet</code> that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html\">Pod Execution Role</a> in the <i>Amazon EKS User Guide</i>.</p> <p>Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.</p> <p>If any Fargate profiles in a cluster are in the <code>DELETING</code> status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html\">Fargate profile</a> in the <i>Amazon EKS User Guide</i>.</p>" }, "CreateNodegroup":{ "name":"CreateNodegroup", @@ -532,7 +532,7 @@ {"shape":"ServerException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Describes an update to an Amazon EKS resource.</p> <p>When the status of the update is <code>Succeeded</code>, the update is complete. If an update fails, the status is <code>Failed</code>, and an error detail explains the reason for the failure.</p>" + "documentation":"<p>Describes an update to an Amazon EKS resource.</p> <p>When the status of the update is <code>Successful</code>, the update is complete. If an update fails, the status is <code>Failed</code>, and an error detail explains the reason for the failure.</p>" }, "DisassociateAccessPolicy":{ "name":"DisassociateAccessPolicy", @@ -790,7 +790,7 @@ {"shape":"ResourceInUseException"}, {"shape":"ResourcePropagationDelayException"} ], - "documentation":"<p>Connects a Kubernetes cluster to the Amazon EKS control plane. </p> <p>Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes. </p> <p>Cluster connection requires two steps. First, send a <code> <a>RegisterClusterRequest</a> </code> to add it to the Amazon EKS control plane.</p> <p>Second, a <a href=\"https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml\">Manifest</a> containing the <code>activationID</code> and <code>activationCode</code> must be applied to the Kubernetes cluster through it's native provider to provide visibility.</p> <p>After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using <code>DeregisterCluster</code>.</p>" + "documentation":"<p>Connects a Kubernetes cluster to the Amazon EKS control plane. </p> <p>Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes. </p> <p>Cluster connection requires two steps. First, send a <a href=\"https://docs.aws.amazon.com/eks/latest/APIReference/API_RegisterClusterRequest.html\"> <code>RegisterClusterRequest</code> </a> to add it to the Amazon EKS control plane.</p> <p>Second, a <a href=\"https://amazon-eks.s3.us-west-2.amazonaws.com/eks-connector/manifests/eks-connector/latest/eks-connector.yaml\">Manifest</a> containing the <code>activationID</code> and <code>activationCode</code> must be applied to the Kubernetes cluster through it's native provider to provide visibility.</p> <p>After the manifest is updated and applied, the connected cluster is visible to the Amazon EKS control plane. If the manifest isn't applied within three days, the connected cluster will no longer be visible and must be deregistered using <code>DeregisterCluster</code>.</p>" }, "TagResource":{ "name":"TagResource", @@ -888,7 +888,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"} ], - "documentation":"<p>Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the <a>DescribeUpdate</a> API operation.</p> <p>Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to <code>UPDATING</code> (this status transition is eventually consistent). When the update is complete (either <code>Failed</code> or <code>Successful</code>), the cluster status moves to <code>Active</code>.</p> <p>If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.</p>" + "documentation":"<p>Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the <a href=\"https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html\"> <code>DescribeUpdate</code> </a> API operation.</p> <p>Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to <code>UPDATING</code> (this status transition is eventually consistent). When the update is complete (either <code>Failed</code> or <code>Successful</code>), the cluster status moves to <code>Active</code>.</p> <p>If your cluster has managed node groups attached to it, all of your node groups' Kubernetes versions must match the cluster's Kubernetes version in order to update the cluster to a new Kubernetes version.</p>" }, "UpdateEksAnywhereSubscription":{ "name":"UpdateEksAnywhereSubscription", @@ -923,7 +923,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"} ], - "documentation":"<p>Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the <a>DescribeUpdate</a> API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.</p>" + "documentation":"<p>Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the <a href=\"https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeUpdate.html\"> <code>DescribeUpdate</code> </a> API operation. You can update the Kubernetes labels and taints for a node group and the scaling and version update configuration.</p>" }, "UpdateNodegroupVersion":{ "name":"UpdateNodegroupVersion", @@ -1155,7 +1155,7 @@ }, "podIdentityAssociations":{ "shape":"StringList", - "documentation":"<p>An array of Pod Identity Assocations owned by the Addon. Each EKS Pod Identity association maps a role to a service account in a namespace in the cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html\">Attach an IAM Role to an Amazon EKS add-on using Pod Identity</a> in the EKS User Guide.</p>" + "documentation":"<p>An array of Pod Identity Assocations owned by the Addon. Each EKS Pod Identity association maps a role to a service account in a namespace in the cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html\">Attach an IAM Role to an Amazon EKS add-on using Pod Identity</a> in the <i>Amazon EKS User Guide</i>.</p>" } }, "documentation":"<p>An Amazon EKS add-on. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html\">Amazon EKS add-ons</a> in the <i>Amazon EKS User Guide</i>.</p>" @@ -1169,10 +1169,10 @@ }, "compatibleVersions":{ "shape":"StringList", - "documentation":"<p>A list of compatible add-on versions.</p>" + "documentation":"<p>The list of compatible Amazon EKS add-on versions for the next Kubernetes version.</p>" } }, - "documentation":"<p>Contains compatibility information for an Amazon EKS add-on.</p>" + "documentation":"<p>The summary information about the Amazon EKS add-on compatibility for the next Kubernetes version for an insight check in the <code>UPGRADE_READINESS</code> category.</p>" }, "AddonCompatibilityDetails":{ "type":"list", @@ -1271,7 +1271,7 @@ "documentation":"<p>The ARN of an IAM Role.</p>" } }, - "documentation":"<p>A type of Pod Identity Association owned by an Amazon EKS Add-on.</p> <p>Each EKS Pod Identity Association maps a role to a service account in a namespace in the cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html\">Attach an IAM Role to an Amazon EKS add-on using Pod Identity</a> in the EKS User Guide.</p>" + "documentation":"<p>A type of Pod Identity Association owned by an Amazon EKS Add-on.</p> <p>Each EKS Pod Identity Association maps a role to a service account in a namespace in the cluster.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html\">Attach an IAM Role to an Amazon EKS add-on using Pod Identity</a> in the <i>Amazon EKS User Guide</i>.</p>" }, "AddonPodIdentityAssociationsList":{ "type":"list", @@ -1530,7 +1530,7 @@ "documentation":"<p>Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.</p>" } }, - "documentation":"<p>Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.</p>" + "documentation":"<p>Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the <i>Amazon EKS User Guide</i>.</p>" }, "Boolean":{"type":"boolean"}, "BoxedBoolean":{ @@ -1711,7 +1711,7 @@ }, "upgradePolicy":{ "shape":"UpgradePolicyResponse", - "documentation":"<p>This value indicates if extended support is enabled or disabled for the cluster.</p> <p> <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html\">Learn more about EKS Extended Support in the EKS User Guide.</a> </p>" + "documentation":"<p>This value indicates if extended support is enabled or disabled for the cluster.</p> <p> <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html\">Learn more about EKS Extended Support in the <i>Amazon EKS User Guide</i>.</a> </p>" }, "zonalShiftConfig":{ "shape":"ZonalShiftConfigResponse", @@ -1723,11 +1723,11 @@ }, "computeConfig":{ "shape":"ComputeConfigResponse", - "documentation":"<p>Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the EKS User Guide.</p>" + "documentation":"<p>Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the <i>Amazon EKS User Guide</i>.</p>" }, "storageConfig":{ "shape":"StorageConfigResponse", - "documentation":"<p>Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.</p>" + "documentation":"<p>Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the <i>Amazon EKS User Guide</i>.</p>" } }, "documentation":"<p>An object representing an Amazon EKS cluster.</p>" @@ -1838,6 +1838,10 @@ }, "status":{ "shape":"ClusterVersionStatus", + "documentation":"<important> <p>This field is deprecated. Use <code>versionStatus</code> instead, as that field matches for input and output of this action.</p> </important> <p>Current status of this cluster version.</p>" + }, + "versionStatus":{ + "shape":"VersionStatus", "documentation":"<p>Current status of this cluster version.</p>" }, "kubernetesPatchVersion":{ @@ -1890,14 +1894,14 @@ }, "nodePools":{ "shape":"StringList", - "documentation":"<p>Configuration for node pools that defines the compute resources for your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the EKS User Guide.</p>" + "documentation":"<p>Configuration for node pools that defines the compute resources for your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the <i>Amazon EKS User Guide</i>.</p>" }, "nodeRoleArn":{ "shape":"String", - "documentation":"<p>The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. This value cannot be changed after the compute capability of EKS Auto Mode is enabled. For more information, see the IAM Reference in the EKS User Guide.</p>" + "documentation":"<p>The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. This value cannot be changed after the compute capability of EKS Auto Mode is enabled. For more information, see the IAM Reference in the <i>Amazon EKS User Guide</i>.</p>" } }, - "documentation":"<p>Request to update the configuration of the compute capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode compute capability in the EKS User Guide.</p>" + "documentation":"<p>Request to update the configuration of the compute capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode compute capability in the <i>Amazon EKS User Guide</i>.</p>" }, "ComputeConfigResponse":{ "type":"structure", @@ -1908,7 +1912,7 @@ }, "nodePools":{ "shape":"StringList", - "documentation":"<p>Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the EKS User Guide.</p>" + "documentation":"<p>Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the <i>Amazon EKS User Guide</i>.</p>" }, "nodeRoleArn":{ "shape":"String", @@ -1983,7 +1987,7 @@ "documentation":"<p>The name of the placement group for the Kubernetes control plane instances. This setting can't be changed after cluster creation. </p>" } }, - "documentation":"<p>The placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html\">Capacity considerations</a> in the Amazon EKS User Guide.</p>" + "documentation":"<p>The placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html\">Capacity considerations</a> in the <i>Amazon EKS User Guide</i>.</p>" }, "ControlPlanePlacementResponse":{ "type":"structure", @@ -2024,7 +2028,7 @@ }, "principalArn":{ "shape":"String", - "documentation":"<p>The ARN of the IAM principal for the <code>AccessEntry</code>. You can specify one ARN for each access entry. You can't specify the same ARN in more than one access entry. This value can't be changed after access entry creation.</p> <p>The valid principals differ depending on the type of the access entry in the <code>type</code> field. The only valid ARN is IAM roles for the types of access entries for nodes: <code/> <code/>. You can use every IAM principal type for <code>STANDARD</code> access entries. You can't use the STS session principal type with access entries because this is a temporary principal for each session and not a permanent identity that can be assigned permissions.</p> <p> <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-users-federation-idp\">IAM best practices</a> recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials. </p>" + "documentation":"<p>The ARN of the IAM principal for the <code>AccessEntry</code>. You can specify one ARN for each access entry. You can't specify the same ARN in more than one access entry. This value can't be changed after access entry creation.</p> <p>The valid principals differ depending on the type of the access entry in the <code>type</code> field. For <code>STANDARD</code> access entries, you can use every IAM principal type. For nodes (<code>EC2</code> (for EKS Auto Mode), <code>EC2_LINUX</code>, <code>EC2_WINDOWS</code>, <code>FARGATE_LINUX</code>, and <code>HYBRID_LINUX</code>), the only valid ARN is IAM roles. You can't use the STS session principal type with access entries because this is a temporary principal for each session and not a permanent identity that can be assigned permissions.</p> <p> <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#bp-users-federation-idp\">IAM best practices</a> recommend using IAM roles with temporary credentials, rather than IAM users with long-term credentials. </p>" }, "kubernetesGroups":{ "shape":"StringList", @@ -2045,7 +2049,7 @@ }, "type":{ "shape":"String", - "documentation":"<p>The type of the new access entry. Valid values are <code>Standard</code>, <code>FARGATE_LINUX</code>, <code>EC2_LINUX</code>, and <code>EC2_WINDOWS</code>.</p> <p>If the <code>principalArn</code> is for an IAM role that's used for self-managed Amazon EC2 nodes, specify <code>EC2_LINUX</code> or <code>EC2_WINDOWS</code>. Amazon EKS grants the necessary permissions to the node for you. If the <code>principalArn</code> is for any other purpose, specify <code>STANDARD</code>. If you don't specify a value, Amazon EKS sets the value to <code>STANDARD</code>. It's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the <code>aws-auth</code> <code>ConfigMap</code> for the roles. You can't change this value once you've created the access entry.</p> <p>If you set the value to <code>EC2_LINUX</code> or <code>EC2_WINDOWS</code>, you can't specify values for <code>kubernetesGroups</code>, or associate an <code>AccessPolicy</code> to the access entry.</p>" + "documentation":"<p>The type of the new access entry. Valid values are <code>STANDARD</code>, <code>FARGATE_LINUX</code>, <code>EC2_LINUX</code>, <code>EC2_WINDOWS</code>, <code>EC2</code> (for EKS Auto Mode), <code>HYBRID_LINUX</code>, and <code>HYPERPOD_LINUX</code>. </p> <p>If the <code>principalArn</code> is for an IAM role that's used for self-managed Amazon EC2 nodes, specify <code>EC2_LINUX</code> or <code>EC2_WINDOWS</code>. Amazon EKS grants the necessary permissions to the node for you. If the <code>principalArn</code> is for any other purpose, specify <code>STANDARD</code>. If you don't specify a value, Amazon EKS sets the value to <code>STANDARD</code>. If you have the access mode of the cluster set to <code>API_AND_CONFIG_MAP</code>, it's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the <code>aws-auth</code> <code>ConfigMap</code> for the roles. You can't change this value once you've created the access entry.</p> <p>If you set the value to <code>EC2_LINUX</code> or <code>EC2_WINDOWS</code>, you can't specify values for <code>kubernetesGroups</code>, or associate an <code>AccessPolicy</code> to the access entry.</p>" } } }, @@ -2082,7 +2086,7 @@ }, "resolveConflicts":{ "shape":"ResolveConflicts", - "documentation":"<p>How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based on the value you choose:</p> <ul> <li> <p> <b>None</b> – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail.</p> </li> <li> <p> <b>Overwrite</b> – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.</p> </li> <li> <p> <b>Preserve</b> – This is similar to the NONE option. If the self-managed version of the add-on is installed on your cluster Amazon EKS doesn't change the add-on resource properties. Creation of the add-on might fail if conflicts are detected. This option works differently during the update operation. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html\">UpdateAddon</a>.</p> </li> </ul> <p>If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.</p>" + "documentation":"<p>How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based on the value you choose:</p> <ul> <li> <p> <b>None</b> – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn't change the value. Creation of the add-on might fail.</p> </li> <li> <p> <b>Overwrite</b> – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.</p> </li> <li> <p> <b>Preserve</b> – This is similar to the NONE option. If the self-managed version of the add-on is installed on your cluster Amazon EKS doesn't change the add-on resource properties. Creation of the add-on might fail if conflicts are detected. This option works differently during the update operation. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html\"> <code>UpdateAddon</code> </a>.</p> </li> </ul> <p>If you don't currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.</p>" }, "clientRequestToken":{ "shape":"String", @@ -2099,7 +2103,7 @@ }, "podIdentityAssociations":{ "shape":"AddonPodIdentityAssociationsList", - "documentation":"<p>An array of Pod Identity Assocations to be created. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html\">Attach an IAM Role to an Amazon EKS add-on using Pod Identity</a> in the EKS User Guide.</p>" + "documentation":"<p>An array of Pod Identity Assocations to be created. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html\">Attach an IAM Role to an Amazon EKS add-on using Pod Identity</a> in the <i>Amazon EKS User Guide</i>.</p>" } } }, @@ -2139,7 +2143,7 @@ }, "logging":{ "shape":"Logging", - "documentation":"<p>Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html\">Amazon EKS Cluster control plane logs</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p> <note> <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see <a href=\"http://aws.amazon.com/cloudwatch/pricing/\">CloudWatch Pricing</a>.</p> </note>" + "documentation":"<p>Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs . By default, cluster control plane logs aren't exported to CloudWatch Logs . For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html\">Amazon EKS Cluster control plane logs</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p> <note> <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see <a href=\"http://aws.amazon.com/cloudwatch/pricing/\">CloudWatch Pricing</a>.</p> </note>" }, "clientRequestToken":{ "shape":"String", @@ -2172,7 +2176,7 @@ }, "zonalShiftConfig":{ "shape":"ZonalShiftConfigRequest", - "documentation":"<p>Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.</p> <p>Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary.</p> <p>You can start a zonal shift for an EKS cluster, or you can allow Amazon Web Services to do it for you by enabling <i>zonal autoshift</i>. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/zone-shift.html\">Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>" + "documentation":"<p>Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.</p> <p>Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary.</p> <p>You can start a zonal shift for an Amazon EKS cluster, or you can allow Amazon Web Services to do it for you by enabling <i>zonal autoshift</i>. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your Amazon EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/zone-shift.html\">Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>" }, "remoteNetworkConfig":{ "shape":"RemoteNetworkConfigRequest", @@ -2912,9 +2916,18 @@ }, "status":{ "shape":"ClusterVersionStatus", - "documentation":"<p>Filter versions by their current status.</p>", + "documentation":"<important> <p>This field is deprecated. Use <code>versionStatus</code> instead, as that field matches for input and output of this action.</p> </important> <p>Filter versions by their current status.</p>", + "deprecated":true, + "deprecatedMessage":"status has been replaced by versionStatus", + "deprecatedSince":"2025-02-15", "location":"querystring", "locationName":"status" + }, + "versionStatus":{ + "shape":"VersionStatus", + "documentation":"<p>Filter versions by their current status.</p>", + "location":"querystring", + "locationName":"versionStatus" } } }, @@ -3315,7 +3328,7 @@ "documentation":"<p>Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account.</p>" } }, - "documentation":"<p>Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. For more information, see EKS Auto Mode load balancing capability in the EKS User Guide.</p>" + "documentation":"<p>Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. For more information, see EKS Auto Mode load balancing capability in the <i>Amazon EKS User Guide</i>.</p>" }, "EncryptionConfig":{ "type":"structure", @@ -3615,7 +3628,7 @@ }, "addonCompatibilityDetails":{ "shape":"AddonCompatibilityDetails", - "documentation":"<p>A list of AddonCompatibilityDetail objects for Amazon EKS add-ons.</p>" + "documentation":"<p>A list of <code>AddonCompatibilityDetail</code> objects for Amazon EKS add-ons.</p>" } }, "documentation":"<p>Summary information that relates to the category of the insight. Currently only returned with certain insights having category <code>UPGRADE_READINESS</code>.</p>" @@ -3828,11 +3841,11 @@ }, "ipFamily":{ "shape":"IpFamily", - "documentation":"<p>Specify which IP family is used to assign Kubernetes pod and service IP addresses. If you don't specify a value, <code>ipv4</code> is used by default. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created. If you specify <code>ipv6</code>, the VPC and subnets that you specify for cluster creation must have both <code>IPv4</code> and <code>IPv6</code> CIDR blocks assigned to them. You can't specify <code>ipv6</code> for clusters in China Regions.</p> <p>You can only specify <code>ipv6</code> for <code>1.21</code> and later clusters that use version <code>1.10.1</code> or later of the Amazon VPC CNI add-on. If you specify <code>ipv6</code>, then ensure that your VPC meets the requirements listed in the considerations listed in <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html\">Assigning IPv6 addresses to pods and services</a> in the Amazon EKS User Guide. Kubernetes assigns services <code>IPv6</code> addresses from the unique local address range <code>(fc00::/7)</code>. You can't specify a custom <code>IPv6</code> CIDR block. Pod addresses are assigned from the subnet's <code>IPv6</code> CIDR.</p>" + "documentation":"<p>Specify which IP family is used to assign Kubernetes pod and service IP addresses. If you don't specify a value, <code>ipv4</code> is used by default. You can only specify an IP family when you create a cluster and can't change this value once the cluster is created. If you specify <code>ipv6</code>, the VPC and subnets that you specify for cluster creation must have both <code>IPv4</code> and <code>IPv6</code> CIDR blocks assigned to them. You can't specify <code>ipv6</code> for clusters in China Regions.</p> <p>You can only specify <code>ipv6</code> for <code>1.21</code> and later clusters that use version <code>1.10.1</code> or later of the Amazon VPC CNI add-on. If you specify <code>ipv6</code>, then ensure that your VPC meets the requirements listed in the considerations listed in <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html\">Assigning IPv6 addresses to pods and services</a> in the <i>Amazon EKS User Guide</i>. Kubernetes assigns services <code>IPv6</code> addresses from the unique local address range <code>(fc00::/7)</code>. You can't specify a custom <code>IPv6</code> CIDR block. Pod addresses are assigned from the subnet's <code>IPv6</code> CIDR.</p>" }, "elasticLoadBalancing":{ "shape":"ElasticLoadBalancing", - "documentation":"<p>Request to enable or disable the load balancing capability on your EKS Auto Mode cluster. For more information, see EKS Auto Mode load balancing capability in the EKS User Guide.</p>" + "documentation":"<p>Request to enable or disable the load balancing capability on your EKS Auto Mode cluster. For more information, see EKS Auto Mode load balancing capability in the <i>Amazon EKS User Guide</i>.</p>" } }, "documentation":"<p>The Kubernetes network configuration for the cluster.</p>" @@ -4099,7 +4112,7 @@ "members":{ "clusters":{ "shape":"StringList", - "documentation":"<p>A list of all of the clusters for your account in the specified Amazon Web Services Region.</p>" + "documentation":"<p>A list of all of the clusters for your account in the specified Amazon Web Services Region .</p>" }, "nextToken":{ "shape":"String", @@ -4362,7 +4375,7 @@ "members":{ "associations":{ "shape":"PodIdentityAssociationSummaries", - "documentation":"<p>The list of summarized descriptions of the associations that are in the cluster and match any filters that you provided.</p> <p>Each summary is simplified by removing these fields compared to the full <code> <a>PodIdentityAssociation</a> </code>:</p> <ul> <li> <p>The IAM role: <code>roleArn</code> </p> </li> <li> <p>The timestamp that the association was created at: <code>createdAt</code> </p> </li> <li> <p>The most recent timestamp that the association was modified at:. <code>modifiedAt</code> </p> </li> <li> <p>The tags on the association: <code>tags</code> </p> </li> </ul>" + "documentation":"<p>The list of summarized descriptions of the associations that are in the cluster and match any filters that you provided.</p> <p>Each summary is simplified by removing these fields compared to the full <a href=\"https://docs.aws.amazon.com/eks/latest/APIReference/API_PodIdentityAssociation.html\"> <code>PodIdentityAssociation</code> </a>:</p> <ul> <li> <p>The IAM role: <code>roleArn</code> </p> </li> <li> <p>The timestamp that the association was created at: <code>createdAt</code> </p> </li> <li> <p>The most recent timestamp that the association was modified at:. <code>modifiedAt</code> </p> </li> <li> <p>The tags on the association: <code>tags</code> </p> </li> </ul>" }, "nextToken":{ "shape":"String", @@ -4455,7 +4468,7 @@ }, "enabled":{ "shape":"BoxedBoolean", - "documentation":"<p>If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.</p>" + "documentation":"<p>If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs . If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.</p>" } }, "documentation":"<p>An object representing the enabled or disabled Kubernetes control plane logs for your cluster.</p>" @@ -4719,9 +4732,20 @@ "maxUnavailablePercentage":{ "shape":"PercentCapacity", "documentation":"<p>The maximum percentage of nodes unavailable during a version update. This percentage of nodes are updated in parallel, up to 100 nodes at once. This value or <code>maxUnavailable</code> is required to have a value.</p>" + }, + "updateStrategy":{ + "shape":"NodegroupUpdateStrategies", + "documentation":"<p>The configuration for the behavior to follow during a node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an <a href=\"https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateNodegroupVersion.html\"> <code>UpdateNodegroupVersion</code> </a> action.</p> <p>An Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI versions in parallel. The <i>update strategy</i> changes the managed node update behavior of the managed node group for each quantity. The <i>default</i> strategy has guardrails to protect you from misconfiguration and launches the new instances first, before terminating the old instances. The <i>minimal</i> strategy removes the guardrails and terminates the old instances before launching the new instances. This minimal strategy is useful in scenarios where you are constrained to resources or costs (for example, with hardware accelerators such as GPUs).</p>" } }, - "documentation":"<p>The node group update configuration.</p>" + "documentation":"<p>The node group update configuration. An Amazon EKS managed node group updates by replacing nodes with new nodes of newer AMI versions in parallel. You choose the <i>maximum unavailable</i> and the <i>update strategy</i>.</p>" + }, + "NodegroupUpdateStrategies":{ + "type":"string", + "enum":[ + "DEFAULT", + "MINIMAL" + ] }, "NonZeroInteger":{ "type":"integer", @@ -4975,7 +4999,7 @@ "documentation":"<p>If defined, the Pod Identity Association is owned by an Amazon EKS Addon.</p>" } }, - "documentation":"<p>The summarized description of the association.</p> <p>Each summary is simplified by removing these fields compared to the full <code> <a>PodIdentityAssociation</a> </code>:</p> <ul> <li> <p>The IAM role: <code>roleArn</code> </p> </li> <li> <p>The timestamp that the association was created at: <code>createdAt</code> </p> </li> <li> <p>The most recent timestamp that the association was modified at:. <code>modifiedAt</code> </p> </li> <li> <p>The tags on the association: <code>tags</code> </p> </li> </ul>" + "documentation":"<p>The summarized description of the association.</p> <p>Each summary is simplified by removing these fields compared to the full <a href=\"https://docs.aws.amazon.com/eks/latest/APIReference/API_PodIdentityAssociation.html\"> <code>PodIdentityAssociation</code> </a>:</p> <ul> <li> <p>The IAM role: <code>roleArn</code> </p> </li> <li> <p>The timestamp that the association was created at: <code>createdAt</code> </p> </li> <li> <p>The most recent timestamp that the association was modified at:. <code>modifiedAt</code> </p> </li> <li> <p>The tags on the association: <code>tags</code> </p> </li> </ul>" }, "Provider":{ "type":"structure", @@ -5246,7 +5270,7 @@ "documentation":"<p>Request to configure EBS Block Storage settings for your EKS Auto Mode cluster.</p>" } }, - "documentation":"<p>Request to update the configuration of the storage capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode block storage capability in the EKS User Guide.</p>" + "documentation":"<p>Request to update the configuration of the storage capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode block storage capability in the <i>Amazon EKS User Guide</i>.</p>" }, "StorageConfigResponse":{ "type":"structure", @@ -5521,7 +5545,7 @@ }, "podIdentityAssociations":{ "shape":"AddonPodIdentityAssociationsList", - "documentation":"<p>An array of Pod Identity Assocations to be updated. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role. If this value is left blank, no change. If an empty array is provided, existing Pod Identity Assocations owned by the Addon are deleted.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html\">Attach an IAM Role to an Amazon EKS add-on using Pod Identity</a> in the EKS User Guide.</p>" + "documentation":"<p>An array of Pod Identity Assocations to be updated. Each EKS Pod Identity association maps a Kubernetes service account to an IAM Role. If this value is left blank, no change. If an empty array is provided, existing Pod Identity Assocations owned by the Addon are deleted.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/add-ons-iam.html\">Attach an IAM Role to an Amazon EKS add-on using Pod Identity</a> in the <i>Amazon EKS User Guide</i>.</p>" } } }, @@ -5544,7 +5568,7 @@ "resourcesVpcConfig":{"shape":"VpcConfigRequest"}, "logging":{ "shape":"Logging", - "documentation":"<p>Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html\">Amazon EKS cluster control plane logs</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p> <note> <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see <a href=\"http://aws.amazon.com/cloudwatch/pricing/\">CloudWatch Pricing</a>.</p> </note>" + "documentation":"<p>Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs . By default, cluster control plane logs aren't exported to CloudWatch Logs . For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html\">Amazon EKS cluster control plane logs</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p> <note> <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see <a href=\"http://aws.amazon.com/cloudwatch/pricing/\">CloudWatch Pricing</a>.</p> </note>" }, "clientRequestToken":{ "shape":"String", @@ -5801,6 +5825,7 @@ "MaxUnavailable", "MaxUnavailablePercentage", "NodeRepairEnabled", + "UpdateStrategy", "ConfigurationValues", "SecurityGroups", "Subnets", @@ -5902,20 +5927,28 @@ "members":{ "supportType":{ "shape":"SupportType", - "documentation":"<p>If the cluster is set to <code>EXTENDED</code>, it will enter extended support at the end of standard support. If the cluster is set to <code>STANDARD</code>, it will be automatically upgraded at the end of standard support.</p> <p> <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html\">Learn more about EKS Extended Support in the EKS User Guide.</a> </p>" + "documentation":"<p>If the cluster is set to <code>EXTENDED</code>, it will enter extended support at the end of standard support. If the cluster is set to <code>STANDARD</code>, it will be automatically upgraded at the end of standard support.</p> <p> <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html\">Learn more about EKS Extended Support in the <i>Amazon EKS User Guide</i>.</a> </p>" } }, - "documentation":"<p>The support policy to use for the cluster. Extended support allows you to remain on specific Kubernetes versions for longer. Clusters in extended support have higher costs. The default value is <code>EXTENDED</code>. Use <code>STANDARD</code> to disable extended support.</p> <p> <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html\">Learn more about EKS Extended Support in the EKS User Guide.</a> </p>" + "documentation":"<p>The support policy to use for the cluster. Extended support allows you to remain on specific Kubernetes versions for longer. Clusters in extended support have higher costs. The default value is <code>EXTENDED</code>. Use <code>STANDARD</code> to disable extended support.</p> <p> <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html\">Learn more about EKS Extended Support in the <i>Amazon EKS User Guide</i>.</a> </p>" }, "UpgradePolicyResponse":{ "type":"structure", "members":{ "supportType":{ "shape":"SupportType", - "documentation":"<p>If the cluster is set to <code>EXTENDED</code>, it will enter extended support at the end of standard support. If the cluster is set to <code>STANDARD</code>, it will be automatically upgraded at the end of standard support.</p> <p> <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html\">Learn more about EKS Extended Support in the EKS User Guide.</a> </p>" + "documentation":"<p>If the cluster is set to <code>EXTENDED</code>, it will enter extended support at the end of standard support. If the cluster is set to <code>STANDARD</code>, it will be automatically upgraded at the end of standard support.</p> <p> <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html\">Learn more about EKS Extended Support in the <i>Amazon EKS User Guide</i>.</a> </p>" } }, - "documentation":"<p>This value indicates if extended support is enabled or disabled for the cluster.</p> <p> <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html\">Learn more about EKS Extended Support in the EKS User Guide.</a> </p>" + "documentation":"<p>This value indicates if extended support is enabled or disabled for the cluster.</p> <p> <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html\">Learn more about EKS Extended Support in the <i>Amazon EKS User Guide</i>.</a> </p>" + }, + "VersionStatus":{ + "type":"string", + "enum":[ + "UNSUPPORTED", + "STANDARD_SUPPORT", + "EXTENDED_SUPPORT" + ] }, "VpcConfigRequest":{ "type":"structure", diff --git a/contrib/python/botocore/py3/botocore/data/emr-containers/2020-10-01/service-2.json b/contrib/python/botocore/py3/botocore/data/emr-containers/2020-10-01/service-2.json index 1b43d1018d4..3f3af0499ae 100644 --- a/contrib/python/botocore/py3/botocore/data/emr-containers/2020-10-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/emr-containers/2020-10-01/service-2.json @@ -359,6 +359,13 @@ "min":44, "pattern":"^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\\d{12}):certificate/.+$" }, + "AllowAWSToRetainLogs":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "AuthorizationConfiguration":{ "type":"structure", "members":{ @@ -1788,6 +1795,20 @@ "min":1, "pattern":"[\\.\\-_/#A-Za-z0-9]+" }, + "ManagedLogs":{ + "type":"structure", + "members":{ + "allowAWSToRetainLogs":{ + "shape":"AllowAWSToRetainLogs", + "documentation":"<p>Determines whether Amazon Web Services can retain logs.</p>" + }, + "encryptionKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"<p>The Amazon resource name (ARN) of the encryption key for logs.</p>" + } + }, + "documentation":"<p>The entity that provides configuration control over managed logs.</p>" + }, "MaxFilesToKeep":{ "type":"integer", "max":50, @@ -1796,6 +1817,10 @@ "MonitoringConfiguration":{ "type":"structure", "members":{ + "managedLogs":{ + "shape":"ManagedLogs", + "documentation":"<p>The entity that controls configuration for managed logs.</p>" + }, "persistentAppUI":{ "shape":"PersistentAppUI", "documentation":"<p>Monitoring configurations for the persistent application UI. </p>" diff --git a/contrib/python/botocore/py3/botocore/data/emr-serverless/2021-07-13/service-2.json b/contrib/python/botocore/py3/botocore/data/emr-serverless/2021-07-13/service-2.json index 86100c0cb3c..d32f0d655d9 100644 --- a/contrib/python/botocore/py3/botocore/data/emr-serverless/2021-07-13/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/emr-serverless/2021-07-13/service-2.json @@ -822,7 +822,7 @@ }, "EntryPointPath":{ "type":"string", - "max":256, + "max":4096, "min":1, "pattern":".*\\S.*", "sensitive":true diff --git a/contrib/python/botocore/py3/botocore/data/endpoints.json b/contrib/python/botocore/py3/botocore/data/endpoints.json index 9af82878a6c..b7c1540fbdd 100644 --- a/contrib/python/botocore/py3/botocore/data/endpoints.json +++ b/contrib/python/botocore/py3/botocore/data/endpoints.json @@ -366,6 +366,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-7" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "acm-pca-fips.ca-central-1.amazonaws.com", @@ -431,6 +432,7 @@ "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, + "mx-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { "variants" : [ { @@ -1360,6 +1362,7 @@ "ap-southeast-2" : { }, "ap-southeast-3" : { }, "ap-southeast-4" : { }, + "ap-southeast-5" : { }, "ca-central-1" : { }, "ca-west-1" : { }, "eu-central-1" : { }, @@ -2924,6 +2927,7 @@ "ap-southeast-3" : { }, "ap-southeast-4" : { }, "ap-southeast-5" : { }, + "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, "eu-central-1" : { }, @@ -2937,6 +2941,7 @@ "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, + "mx-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -3063,7 +3068,9 @@ "endpoints" : { "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-northeast-3" : { }, "ap-south-1" : { }, + "ap-south-2" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "bedrock-ap-northeast-1" : { @@ -3078,12 +3085,24 @@ }, "hostname" : "bedrock.ap-northeast-2.amazonaws.com" }, + "bedrock-ap-northeast-3" : { + "credentialScope" : { + "region" : "ap-northeast-3" + }, + "hostname" : "bedrock.ap-northeast-3.amazonaws.com" + }, "bedrock-ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" }, "hostname" : "bedrock.ap-south-1.amazonaws.com" }, + "bedrock-ap-south-2" : { + "credentialScope" : { + "region" : "ap-south-2" + }, + "hostname" : "bedrock.ap-south-2.amazonaws.com" + }, "bedrock-ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" @@ -3168,12 +3187,24 @@ }, "hostname" : "bedrock-runtime.ap-northeast-2.amazonaws.com" }, + "bedrock-runtime-ap-northeast-3" : { + "credentialScope" : { + "region" : "ap-northeast-3" + }, + "hostname" : "bedrock-runtime.ap-northeast-3.amazonaws.com" + }, "bedrock-runtime-ap-south-1" : { "credentialScope" : { "region" : "ap-south-1" }, "hostname" : "bedrock-runtime.ap-south-1.amazonaws.com" }, + "bedrock-runtime-ap-south-2" : { + "credentialScope" : { + "region" : "ap-south-2" + }, + "hostname" : "bedrock-runtime.ap-south-2.amazonaws.com" + }, "bedrock-runtime-ap-southeast-1" : { "credentialScope" : { "region" : "ap-southeast-1" @@ -3393,6 +3424,7 @@ }, "cassandra" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -3774,6 +3806,12 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-7" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.ap-southeast-7.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "ca-central-1" : { "variants" : [ { "hostname" : "cloudcontrolapi-fips.ca-central-1.amazonaws.com", @@ -3906,6 +3944,12 @@ "tags" : [ "dualstack" ] } ] }, + "mx-central-1" : { + "variants" : [ { + "hostname" : "cloudcontrolapi.mx-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "sa-east-1" : { "variants" : [ { "hostname" : "cloudcontrolapi.sa-east-1.api.aws", @@ -5287,10 +5331,22 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, - "ca-central-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "comprehend-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "comprehend-fips.ca-central-1.amazonaws.com" + }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -8756,6 +8812,13 @@ "deprecated" : true, "hostname" : "elasticfilesystem-fips.me-south-1.amazonaws.com" }, + "fips-mx-central-1" : { + "credentialScope" : { + "region" : "mx-central-1" + }, + "deprecated" : true, + "hostname" : "elasticfilesystem-fips.mx-central-1.amazonaws.com" + }, "fips-sa-east-1" : { "credentialScope" : { "region" : "sa-east-1" @@ -8809,6 +8872,12 @@ "tags" : [ "fips" ] } ] }, + "mx-central-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.mx-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "sa-east-1" : { "variants" : [ { "hostname" : "elasticfilesystem-fips.sa-east-1.amazonaws.com", @@ -11053,13 +11122,41 @@ }, "groundstation" : { "endpoints" : { - "af-south-1" : { }, - "ap-northeast-2" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-west-1" : { }, + "af-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -11081,24 +11178,47 @@ "deprecated" : true, "hostname" : "groundstation-fips.us-west-2.amazonaws.com" }, - "me-south-1" : { }, - "sa-east-1" : { }, + "me-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, "us-east-1" : { "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "groundstation-fips.us-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "groundstation-fips.us-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "us-east-2" : { "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "groundstation-fips.us-east-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "groundstation-fips.us-east-2.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "us-west-2" : { "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "groundstation-fips.us-west-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "groundstation-fips.us-west-2.api.aws", + "tags" : [ "dualstack", "fips" ] } ] } } @@ -11119,6 +11239,7 @@ "ap-southeast-2" : { }, "ap-southeast-3" : { }, "ap-southeast-4" : { }, + "ap-southeast-5" : { }, "ca-central-1" : { }, "ca-west-1" : { }, "eu-central-1" : { }, @@ -17035,6 +17156,12 @@ "tags" : [ "dualstack" ] } ] }, + "eu-south-2" : { + "variants" : [ { + "hostname" : "polly.eu-south-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "eu-west-1" : { "variants" : [ { "hostname" : "polly.eu-west-1.api.aws", @@ -17573,7 +17700,6 @@ "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ap-southeast-3" : { }, - "api" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-central-2" : { }, @@ -17590,39 +17716,133 @@ }, "ram" : { "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-northeast-3" : { }, - "ap-south-1" : { }, - "ap-south-2" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ap-southeast-3" : { }, - "ap-southeast-4" : { }, - "ap-southeast-5" : { }, - "ap-southeast-7" : { }, + "af-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-east-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-3" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-3" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-4" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-5" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-7" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, "ca-central-1" : { "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "ram-fips.ca-central-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "ram-fips.ca-central-1.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "ca-west-1" : { "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "ram-fips.ca-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "ram-fips.ca-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "tags" : [ "dualstack" ] } ] }, - "eu-central-1" : { }, - "eu-central-2" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-south-2" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, "fips-ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" @@ -17665,33 +17885,73 @@ "deprecated" : true, "hostname" : "ram-fips.us-west-2.amazonaws.com" }, - "il-central-1" : { }, - "me-central-1" : { }, - "me-south-1" : { }, - "mx-central-1" : { }, - "sa-east-1" : { }, + "il-central-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "me-central-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "me-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "mx-central-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, "us-east-1" : { "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "ram-fips.us-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "ram-fips.us-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "us-east-2" : { "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "ram-fips.us-east-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "ram-fips.us-east-2.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "us-west-1" : { "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "ram-fips.us-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "ram-fips.us-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "us-west-2" : { "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "ram-fips.us-west-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "ram-fips.us-west-2.api.aws", + "tags" : [ "dualstack", "fips" ] } ] } } @@ -18597,26 +18857,126 @@ }, "resiliencehub" : { "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-south-1" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ca-central-1" : { }, - "eu-central-1" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, - "me-south-1" : { }, - "sa-east-1" : { }, - "us-east-1" : { }, - "us-east-2" : { }, - "us-west-1" : { }, - "us-west-2" : { } + "af-south-1" : { + "variants" : [ { + "hostname" : "resiliencehub.af-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-east-1" : { + "variants" : [ { + "hostname" : "resiliencehub.ap-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-1" : { + "variants" : [ { + "hostname" : "resiliencehub.ap-northeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "resiliencehub.ap-northeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "resiliencehub.ap-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "hostname" : "resiliencehub.ap-southeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "hostname" : "resiliencehub.ap-southeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "resiliencehub.ca-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "resiliencehub.eu-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "hostname" : "resiliencehub.eu-north-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-1" : { + "variants" : [ { + "hostname" : "resiliencehub.eu-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "resiliencehub.eu-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "resiliencehub.eu-west-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "resiliencehub.eu-west-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "me-south-1" : { + "variants" : [ { + "hostname" : "resiliencehub.me-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "hostname" : "resiliencehub.sa-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "resiliencehub.us-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "us-east-2" : { + "variants" : [ { + "hostname" : "resiliencehub.us-east-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "us-west-1" : { + "variants" : [ { + "hostname" : "resiliencehub.us-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "resiliencehub.us-west-2.api.aws", + "tags" : [ "dualstack" ] + } ] + } } }, "resource-explorer-2" : { @@ -18850,6 +19210,8 @@ "ap-southeast-2" : { }, "ap-southeast-3" : { }, "ap-southeast-4" : { }, + "ap-southeast-5" : { }, + "ap-southeast-7" : { }, "ca-central-1" : { }, "ca-west-1" : { }, "eu-central-1" : { }, @@ -18891,6 +19253,7 @@ "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, + "mx-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { "variants" : [ { @@ -20512,6 +20875,12 @@ "tags" : [ "dualstack" ] } ] }, + "ap-southeast-7" : { + "variants" : [ { + "hostname" : "securityhub.ap-southeast-7.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "ca-central-1" : { "variants" : [ { "hostname" : "securityhub.ca-central-1.api.aws", @@ -20618,6 +20987,12 @@ "tags" : [ "dualstack" ] } ] }, + "mx-central-1" : { + "variants" : [ { + "hostname" : "securityhub.mx-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "sa-east-1" : { "variants" : [ { "hostname" : "securityhub.sa-east-1.api.aws", @@ -22307,8 +22682,18 @@ "ap-southeast-4" : { }, "ap-southeast-5" : { }, "ap-southeast-7" : { }, - "ca-central-1" : { }, - "ca-west-1" : { }, + "ca-central-1" : { + "variants" : [ { + "hostname" : "sqs-fips.ca-central-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "ca-west-1" : { + "variants" : [ { + "hostname" : "sqs-fips.ca-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, @@ -22317,6 +22702,20 @@ "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, + "fips-ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "deprecated" : true, + "hostname" : "sqs-fips.ca-central-1.amazonaws.com" + }, + "fips-ca-west-1" : { + "credentialScope" : { + "region" : "ca-west-1" + }, + "deprecated" : true, + "hostname" : "sqs-fips.ca-west-1.amazonaws.com" + }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -23118,6 +23517,7 @@ "il-central-1" : { }, "me-central-1" : { }, "me-south-1" : { }, + "mx-central-1" : { }, "sa-east-1" : { }, "us-east-1" : { "variants" : [ { @@ -23441,39 +23841,156 @@ }, "synthetics" : { "endpoints" : { - "af-south-1" : { }, - "ap-east-1" : { }, - "ap-northeast-1" : { }, - "ap-northeast-2" : { }, - "ap-northeast-3" : { }, - "ap-south-1" : { }, - "ap-south-2" : { }, - "ap-southeast-1" : { }, - "ap-southeast-2" : { }, - "ap-southeast-3" : { }, - "ap-southeast-4" : { }, - "ap-southeast-5" : { }, - "ap-southeast-7" : { }, + "af-south-1" : { + "variants" : [ { + "hostname" : "synthetics.af-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-east-1" : { + "variants" : [ { + "hostname" : "synthetics.ap-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-1" : { + "variants" : [ { + "hostname" : "synthetics.ap-northeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-2" : { + "variants" : [ { + "hostname" : "synthetics.ap-northeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-northeast-3" : { + "variants" : [ { + "hostname" : "synthetics.ap-northeast-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-1" : { + "variants" : [ { + "hostname" : "synthetics.ap-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-south-2" : { + "variants" : [ { + "hostname" : "synthetics.ap-south-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-1" : { + "variants" : [ { + "hostname" : "synthetics.ap-southeast-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-2" : { + "variants" : [ { + "hostname" : "synthetics.ap-southeast-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-3" : { + "variants" : [ { + "hostname" : "synthetics.ap-southeast-3.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-4" : { + "variants" : [ { + "hostname" : "synthetics.ap-southeast-4.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-5" : { + "variants" : [ { + "hostname" : "synthetics.ap-southeast-5.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "ap-southeast-7" : { + "variants" : [ { + "hostname" : "synthetics.ap-southeast-7.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "ca-central-1" : { "variants" : [ { "hostname" : "synthetics-fips.ca-central-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "synthetics-fips.ca-central-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "synthetics.ca-central-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "ca-west-1" : { "variants" : [ { "hostname" : "synthetics-fips.ca-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "synthetics-fips.ca-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "synthetics.ca-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-1" : { + "variants" : [ { + "hostname" : "synthetics.eu-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-central-2" : { + "variants" : [ { + "hostname" : "synthetics.eu-central-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-north-1" : { + "variants" : [ { + "hostname" : "synthetics.eu-north-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-1" : { + "variants" : [ { + "hostname" : "synthetics.eu-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-south-2" : { + "variants" : [ { + "hostname" : "synthetics.eu-south-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-1" : { + "variants" : [ { + "hostname" : "synthetics.eu-west-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-2" : { + "variants" : [ { + "hostname" : "synthetics.eu-west-2.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "eu-west-3" : { + "variants" : [ { + "hostname" : "synthetics.eu-west-3.api.aws", + "tags" : [ "dualstack" ] } ] }, - "eu-central-1" : { }, - "eu-central-2" : { }, - "eu-north-1" : { }, - "eu-south-1" : { }, - "eu-south-2" : { }, - "eu-west-1" : { }, - "eu-west-2" : { }, - "eu-west-3" : { }, "fips-ca-central-1" : { "credentialScope" : { "region" : "ca-central-1" @@ -23516,33 +24033,82 @@ "deprecated" : true, "hostname" : "synthetics-fips.us-west-2.amazonaws.com" }, - "il-central-1" : { }, - "me-central-1" : { }, - "me-south-1" : { }, - "mx-central-1" : { }, - "sa-east-1" : { }, + "il-central-1" : { + "variants" : [ { + "hostname" : "synthetics.il-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "me-central-1" : { + "variants" : [ { + "hostname" : "synthetics.me-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "me-south-1" : { + "variants" : [ { + "hostname" : "synthetics.me-south-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "mx-central-1" : { + "variants" : [ { + "hostname" : "synthetics.mx-central-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, + "sa-east-1" : { + "variants" : [ { + "hostname" : "synthetics.sa-east-1.api.aws", + "tags" : [ "dualstack" ] + } ] + }, "us-east-1" : { "variants" : [ { "hostname" : "synthetics-fips.us-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "synthetics-fips.us-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "synthetics.us-east-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-east-2" : { "variants" : [ { "hostname" : "synthetics-fips.us-east-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "synthetics-fips.us-east-2.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "synthetics.us-east-2.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-west-1" : { "variants" : [ { "hostname" : "synthetics-fips.us-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "synthetics-fips.us-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "synthetics.us-west-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-west-2" : { "variants" : [ { "hostname" : "synthetics-fips.us-west-2.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "synthetics-fips.us-west-2.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "synthetics.us-west-2.api.aws", + "tags" : [ "dualstack" ] } ] } } @@ -26838,8 +27404,16 @@ }, "ram" : { "endpoints" : { - "cn-north-1" : { }, - "cn-northwest-1" : { } + "cn-north-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "cn-northwest-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + } } }, "rbin" : { @@ -27205,8 +27779,18 @@ }, "synthetics" : { "endpoints" : { - "cn-north-1" : { }, - "cn-northwest-1" : { } + "cn-north-1" : { + "variants" : [ { + "hostname" : "synthetics.cn-north-1.api.amazonwebservices.com.cn", + "tags" : [ "dualstack" ] + } ] + }, + "cn-northwest-1" : { + "variants" : [ { + "hostname" : "synthetics.cn-northwest-1.api.amazonwebservices.com.cn", + "tags" : [ "dualstack" ] + } ] + } } }, "tagging" : { @@ -28926,7 +29510,7 @@ "endpoints" : { "us-gov-east-1" : { "variants" : [ { - "hostname" : "dynamodb.us-gov-east-1.amazonaws.com", + "hostname" : "dynamodb-fips.us-gov-east-1.amazonaws.com", "tags" : [ "fips" ] } ] }, @@ -28935,11 +29519,11 @@ "region" : "us-gov-east-1" }, "deprecated" : true, - "hostname" : "dynamodb.us-gov-east-1.amazonaws.com" + "hostname" : "dynamodb-fips.us-gov-east-1.amazonaws.com" }, "us-gov-west-1" : { "variants" : [ { - "hostname" : "dynamodb.us-gov-west-1.amazonaws.com", + "hostname" : "dynamodb-fips.us-gov-west-1.amazonaws.com", "tags" : [ "fips" ] } ] }, @@ -28948,7 +29532,7 @@ "region" : "us-gov-west-1" }, "deprecated" : true, - "hostname" : "dynamodb.us-gov-west-1.amazonaws.com" + "hostname" : "dynamodb-fips.us-gov-west-1.amazonaws.com" } } }, @@ -30982,7 +31566,6 @@ }, "quicksight" : { "endpoints" : { - "api" : { }, "us-gov-west-1" : { } } }, @@ -30994,8 +31577,13 @@ }, "hostname" : "ram.us-gov-east-1.amazonaws.com", "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "ram.us-gov-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "ramus-gov-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "us-gov-east-1-fips" : { @@ -31011,8 +31599,13 @@ }, "hostname" : "ram.us-gov-west-1.amazonaws.com", "variants" : [ { + "tags" : [ "dualstack" ] + }, { "hostname" : "ram.us-gov-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "ramus-gov-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] } ] }, "us-gov-west-1-fips" : { @@ -31216,12 +31809,24 @@ "variants" : [ { "hostname" : "resiliencehub-fips.us-gov-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "resiliencehub-fips.us-gov-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "resiliencehub.us-gov-east-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-gov-west-1" : { "variants" : [ { "hostname" : "resiliencehub-fips.us-gov-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "resiliencehub-fips.us-gov-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "resiliencehub.us-gov-west-1.api.aws", + "tags" : [ "dualstack" ] } ] } } @@ -32313,12 +32918,24 @@ "variants" : [ { "hostname" : "synthetics-fips.us-gov-east-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "synthetics-fips.us-gov-east-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "synthetics.us-gov-east-1.api.aws", + "tags" : [ "dualstack" ] } ] }, "us-gov-west-1" : { "variants" : [ { "hostname" : "synthetics-fips.us-gov-west-1.amazonaws.com", "tags" : [ "fips" ] + }, { + "hostname" : "synthetics-fips.us-gov-west-1.api.aws", + "tags" : [ "dualstack", "fips" ] + }, { + "hostname" : "synthetics.us-gov-west-1.api.aws", + "tags" : [ "dualstack" ] } ] } } @@ -32890,8 +33507,32 @@ }, "config" : { "endpoints" : { - "us-iso-east-1" : { }, - "us-iso-west-1" : { } + "fips-us-iso-east-1" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "deprecated" : true, + "hostname" : "config-fips.us-iso-east-1.c2s.ic.gov" + }, + "fips-us-iso-west-1" : { + "credentialScope" : { + "region" : "us-iso-west-1" + }, + "deprecated" : true, + "hostname" : "config-fips.us-iso-west-1.c2s.ic.gov" + }, + "us-iso-east-1" : { + "variants" : [ { + "hostname" : "config-fips.us-iso-east-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-iso-west-1" : { + "variants" : [ { + "hostname" : "config-fips.us-iso-west-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + } } }, "datapipeline" : { @@ -33691,7 +34332,19 @@ "protocols" : [ "https" ] }, "endpoints" : { - "us-iso-east-1" : { } + "fips-us-iso-east-1" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "deprecated" : true, + "hostname" : "fips.transcribe.us-iso-east-1.c2s.ic.gov" + }, + "us-iso-east-1" : { + "variants" : [ { + "hostname" : "fips.transcribe.us-iso-east-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + } } }, "transcribestreaming" : { @@ -33704,7 +34357,19 @@ "protocols" : [ "https" ] }, "endpoints" : { - "us-iso-east-1" : { } + "us-iso-east-1" : { + "variants" : [ { + "hostname" : "translate-fips.us-iso-east-1.c2s.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-iso-east-1-fips" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "deprecated" : true, + "hostname" : "translate-fips.us-iso-east-1.c2s.ic.gov" + } } }, "workspaces" : { @@ -33848,7 +34513,19 @@ }, "config" : { "endpoints" : { - "us-isob-east-1" : { } + "fips-us-isob-east-1" : { + "credentialScope" : { + "region" : "us-isob-east-1" + }, + "deprecated" : true, + "hostname" : "config-fips.us-isob-east-1.sc2s.sgov.gov" + }, + "us-isob-east-1" : { + "variants" : [ { + "hostname" : "config-fips.us-isob-east-1.sc2s.sgov.gov", + "tags" : [ "fips" ] + } ] + } } }, "directconnect" : { @@ -34450,8 +35127,762 @@ "partition" : "aws-iso-f", "partitionName" : "AWS ISOF", "regionRegex" : "^us\\-isof\\-\\w+\\-\\d+$", - "regions" : { }, - "services" : { } + "regions" : { + "us-isof-east-1" : { + "description" : "US ISOF EAST" + }, + "us-isof-south-1" : { + "description" : "US ISOF SOUTH" + } + }, + "services" : { + "access-analyzer" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "acm" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "acm-pca" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "api.ecr" : { + "endpoints" : { + "us-isof-east-1" : { + "credentialScope" : { + "region" : "us-isof-east-1" + }, + "hostname" : "api.ecr.us-isof-east-1.csp.hci.ic.gov" + }, + "us-isof-south-1" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "hostname" : "api.ecr.us-isof-south-1.csp.hci.ic.gov" + } + } + }, + "api.pricing" : { + "defaults" : { + "credentialScope" : { + "service" : "pricing" + } + }, + "endpoints" : { + "us-isof-south-1" : { } + } + }, + "api.sagemaker" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "appconfig" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "appconfigdata" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "application-autoscaling" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "arc-zonal-shift" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "athena" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "autoscaling" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "backup" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "batch" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "budgets" : { + "endpoints" : { + "aws-iso-f-global" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "hostname" : "budgets.global.csp.hci.ic.gov" + }, + "us-isof-south-1" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "hostname" : "budgets.global.csp.hci.ic.gov" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-iso-f-global" + }, + "cloudformation" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "cloudtrail" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "codebuild" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "codedeploy" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "codepipeline" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "comprehend" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "compute-optimizer" : { + "endpoints" : { + "us-isof-south-1" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "hostname" : "compute-optimizer.us-isof-south-1.csp.hci.ic.gov" + } + } + }, + "config" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "cost-optimization-hub" : { + "endpoints" : { + "us-isof-south-1" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "hostname" : "cost-optimization-hub.us-isof-south-1.csp.hci.ic.gov" + } + } + }, + "directconnect" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "dlm" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "dms" : { + "endpoints" : { + "dms" : { + "credentialScope" : { + "region" : "us-isof-east-1" + }, + "deprecated" : true, + "variants" : [ { + "hostname" : "dms.us-isof-east-1.csp.hci.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "dms-fips" : { + "credentialScope" : { + "region" : "us-isof-east-1" + }, + "deprecated" : true, + "hostname" : "dms.us-isof-east-1.csp.hci.ic.gov" + }, + "us-isof-east-1" : { + "variants" : [ { + "hostname" : "dms.us-isof-east-1.csp.hci.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-isof-east-1-fips" : { + "credentialScope" : { + "region" : "us-isof-east-1" + }, + "deprecated" : true, + "hostname" : "dms.us-isof-east-1.csp.hci.ic.gov" + }, + "us-isof-south-1" : { + "variants" : [ { + "hostname" : "dms.us-isof-south-1.csp.hci.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-isof-south-1-fips" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "deprecated" : true, + "hostname" : "dms.us-isof-south-1.csp.hci.ic.gov" + } + } + }, + "ds" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "dynamodb" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "ebs" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "ec2" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "ecs" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "eks" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "elasticache" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "elasticfilesystem" : { + "endpoints" : { + "fips-us-isof-east-1" : { + "credentialScope" : { + "region" : "us-isof-east-1" + }, + "deprecated" : true, + "hostname" : "elasticfilesystem-fips.us-isof-east-1.csp.hci.ic.gov" + }, + "fips-us-isof-south-1" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "deprecated" : true, + "hostname" : "elasticfilesystem-fips.us-isof-south-1.csp.hci.ic.gov" + }, + "us-isof-east-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.us-isof-east-1.csp.hci.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-isof-south-1" : { + "variants" : [ { + "hostname" : "elasticfilesystem-fips.us-isof-south-1.csp.hci.ic.gov", + "tags" : [ "fips" ] + } ] + } + } + }, + "elasticloadbalancing" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "elasticmapreduce" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "es" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "events" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "firehose" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "fsx" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "glue" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "guardduty" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + }, + "isRegionalized" : true + }, + "iam" : { + "endpoints" : { + "aws-iso-f-global" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "hostname" : "iam.us-isof-south-1.csp.hci.ic.gov" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-iso-f-global" + }, + "kinesis" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "kms" : { + "endpoints" : { + "ProdFips" : { + "credentialScope" : { + "region" : "us-isof-east-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-isof-east-1.csp.hci.ic.gov" + }, + "us-isof-east-1" : { + "variants" : [ { + "hostname" : "kms-fips.us-isof-east-1.csp.hci.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-isof-east-1-fips" : { + "credentialScope" : { + "region" : "us-isof-east-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-isof-east-1.csp.hci.ic.gov" + }, + "us-isof-south-1" : { + "variants" : [ { + "hostname" : "kms-fips.us-isof-south-1.csp.hci.ic.gov", + "tags" : [ "fips" ] + } ] + }, + "us-isof-south-1-fips" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.us-isof-south-1.csp.hci.ic.gov" + } + } + }, + "lakeformation" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "lambda" : { + "endpoints" : { + "us-isof-east-1" : { + "variants" : [ { + "hostname" : "lambda.us-isof-east-1.api.aws.hci.ic.gov", + "tags" : [ "dualstack" ] + } ] + }, + "us-isof-south-1" : { + "variants" : [ { + "hostname" : "lambda.us-isof-south-1.api.aws.hci.ic.gov", + "tags" : [ "dualstack" ] + } ] + } + } + }, + "license-manager" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "logs" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "metrics.sagemaker" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "monitoring" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "oam" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "organizations" : { + "endpoints" : { + "aws-iso-f-global" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "hostname" : "organizations.us-isof-south-1.csp.hci.ic.gov" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-iso-f-global" + }, + "pi" : { + "endpoints" : { + "us-isof-east-1" : { + "protocols" : [ "https" ] + }, + "us-isof-south-1" : { + "protocols" : [ "https" ] + } + } + }, + "pipes" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "quicksight" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "ram" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "rbin" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "rds" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "redshift" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "redshift-serverless" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "rekognition" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "resource-groups" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "route53" : { + "endpoints" : { + "aws-iso-f-global" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "hostname" : "route53.csp.hci.ic.gov" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-iso-f-global" + }, + "route53resolver" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "s3" : { + "defaults" : { + "protocols" : [ "http", "https" ], + "signatureVersions" : [ "s3v4" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "savingsplans" : { + "endpoints" : { + "aws-iso-f-global" : { + "credentialScope" : { + "region" : "us-isof-south-1" + }, + "hostname" : "savingsplans.csp.hci.ic.gov" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-iso-f-global" + }, + "scheduler" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "secretsmanager" : { + "endpoints" : { + "us-isof-east-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + }, + "us-isof-south-1" : { + "variants" : [ { + "tags" : [ "dualstack" ] + } ] + } + } + }, + "servicediscovery" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "servicequotas" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "sns" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "sqs" : { + "defaults" : { + "protocols" : [ "http", "https" ], + "sslCommonName" : "{region}.queue.{dnsSuffix}" + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "ssm" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "states" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "streams.dynamodb" : { + "defaults" : { + "credentialScope" : { + "service" : "dynamodb" + }, + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "sts" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "swf" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "synthetics" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "tagging" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "textract" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "transcribe" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "transcribestreaming" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "translate" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + }, + "xray" : { + "endpoints" : { + "us-isof-east-1" : { }, + "us-isof-south-1" : { } + } + } + } }, { "defaults" : { "hostname" : "{service}.{region}.{dnsSuffix}", diff --git a/contrib/python/botocore/py3/botocore/data/firehose/2015-08-04/service-2.json b/contrib/python/botocore/py3/botocore/data/firehose/2015-08-04/service-2.json index cca217dd08a..9d6974f03d1 100644 --- a/contrib/python/botocore/py3/botocore/data/firehose/2015-08-04/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/firehose/2015-08-04/service-2.json @@ -648,7 +648,7 @@ }, "WarehouseLocation":{ "shape":"WarehouseLocation", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The warehouse location for Apache Iceberg tables. You must configure this when schema evolution and table creation is enabled.</p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, "documentation":"<p> Describes the containers where the destination Apache Iceberg Tables are persisted. </p>" @@ -754,6 +754,10 @@ "shape":"DeliveryStreamType", "documentation":"<p>The Firehose stream type. This parameter can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the Firehose stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The Firehose stream uses a Kinesis data stream as a source.</p> </li> </ul>" }, + "DirectPutSourceConfiguration":{ + "shape":"DirectPutSourceConfiguration", + "documentation":"<p>The structure that configures parameters such as <code>ThroughputHintInMBs</code> for a stream configured with Direct PUT as a source. </p>" + }, "KinesisStreamSourceConfiguration":{ "shape":"KinesisStreamSourceConfiguration", "documentation":"<p>When a Kinesis data stream is used as the source for the Firehose stream, a <a>KinesisStreamSourceConfiguration</a> containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.</p>" @@ -777,7 +781,7 @@ }, "ElasticsearchDestinationConfiguration":{ "shape":"ElasticsearchDestinationConfiguration", - "documentation":"<p>The destination in Amazon ES. You can specify only one destination.</p>" + "documentation":"<p>The destination in Amazon OpenSearch Service. You can specify only one destination.</p>" }, "AmazonopensearchserviceDestinationConfiguration":{ "shape":"AmazonopensearchserviceDestinationConfiguration", @@ -793,7 +797,7 @@ }, "Tags":{ "shape":"TagDeliveryStreamInputTagList", - "documentation":"<p>A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User Guide.</p> <p>You can specify up to 50 tags when creating a Firehose stream.</p> <p>If you specify tags in the <code>CreateDeliveryStream</code> action, Amazon Data Firehose performs an additional authorization on the <code>firehose:TagDeliveryStream</code> action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose Firehose streams with IAM resource tags will fail with an <code>AccessDeniedException</code> such as following.</p> <p> <b>AccessDeniedException</b> </p> <p>User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.</p> <p>For an example IAM policy, see <a href=\"https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples\">Tag example.</a> </p>" + "documentation":"<p>A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using Cost Allocation Tags</a> in the Amazon Web Services Billing and Cost Management User Guide.</p> <p>You can specify up to 50 tags when creating a Firehose stream.</p> <p>If you specify tags in the <code>CreateDeliveryStream</code> action, Amazon Data Firehose performs an additional authorization on the <code>firehose:TagDeliveryStream</code> action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an <code>AccessDeniedException</code> such as following.</p> <p> <b>AccessDeniedException</b> </p> <p>User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.</p> <p>For an example IAM policy, see <a href=\"https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples\">Tag example.</a> </p>" }, "AmazonOpenSearchServerlessDestinationConfiguration":{ "shape":"AmazonOpenSearchServerlessDestinationConfiguration", @@ -810,7 +814,7 @@ }, "DatabaseSourceConfiguration":{ "shape":"DatabaseSourceConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The top level object for configuring streams with database as a source. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } } }, @@ -877,14 +881,14 @@ "members":{ "Include":{ "shape":"DatabaseColumnIncludeOrExcludeList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The list of column patterns in source database to be included for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Exclude":{ "shape":"DatabaseColumnIncludeOrExcludeList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The list of column patterns in source database to be excluded for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The structure used to configure the list of column patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseColumnName":{ "type":"string", @@ -907,14 +911,14 @@ "members":{ "Include":{ "shape":"DatabaseIncludeOrExcludeList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The list of database patterns in source database endpoint to be included for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Exclude":{ "shape":"DatabaseIncludeOrExcludeList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The list of database patterns in source database endpoint to be excluded for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The structure used to configure the list of database patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseName":{ "type":"string", @@ -939,27 +943,27 @@ "members":{ "Id":{ "shape":"NonEmptyStringWithoutWhitespace", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The identifier of the current snapshot of the table in source database endpoint. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Table":{ "shape":"DatabaseTableName", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The fully qualified name of the table in source database endpoint that Firehose reads. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "RequestTimestamp":{ "shape":"Timestamp", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The timestamp when the current snapshot is taken on the table. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "RequestedBy":{ "shape":"SnapshotRequestedBy", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The principal that sent the request to take the current snapshot on the table. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Status":{ "shape":"SnapshotStatus", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The status of the current snapshot of the table. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "FailureDescription":{"shape":"FailureDescription"} }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The structure that describes the snapshot information of a table in source database endpoint that Firehose reads. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseSnapshotInfoList":{ "type":"list", @@ -971,7 +975,7 @@ "members":{ "SecretsManagerConfiguration":{"shape":"SecretsManagerConfiguration"} }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The structure to configure the authentication methods for Firehose to connect to source database endpoint. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseSourceConfiguration":{ "type":"structure", @@ -988,104 +992,104 @@ "members":{ "Type":{ "shape":"DatabaseType", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The type of database engine. This can be one of the following values. </p> <ul> <li> <p>MySQL</p> </li> <li> <p>PostgreSQL</p> </li> </ul> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Endpoint":{ "shape":"DatabaseEndpoint", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The endpoint of the database server. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Port":{ "shape":"DatabasePort", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The port of the database. This can be one of the following values.</p> <ul> <li> <p>3306 for MySQL database type</p> </li> <li> <p>5432 for PostgreSQL database type</p> </li> </ul> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "SSLMode":{ "shape":"SSLMode", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The mode to enable or disable SSL when Firehose connects to the database endpoint. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Databases":{ "shape":"DatabaseList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The list of database patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Tables":{ "shape":"DatabaseTableList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The list of table patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Columns":{ "shape":"DatabaseColumnList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The list of column patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "SurrogateKeys":{ "shape":"DatabaseSurrogateKeyList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "SnapshotWatermarkTable":{ "shape":"DatabaseTableName", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseSourceAuthenticationConfiguration":{ "shape":"DatabaseSourceAuthenticationConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The structure to configure the authentication methods for Firehose to connect to source database endpoint. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseSourceVPCConfiguration":{ "shape":"DatabaseSourceVPCConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The top level object for configuring streams with database as a source. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseSourceDescription":{ "type":"structure", "members":{ "Type":{ "shape":"DatabaseType", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The type of database engine. This can be one of the following values. </p> <ul> <li> <p>MySQL</p> </li> <li> <p>PostgreSQL</p> </li> </ul> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Endpoint":{ "shape":"DatabaseEndpoint", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The endpoint of the database server. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Port":{ "shape":"DatabasePort", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The port of the database. This can be one of the following values.</p> <ul> <li> <p>3306 for MySQL database type</p> </li> <li> <p>5432 for PostgreSQL database type</p> </li> </ul> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "SSLMode":{ "shape":"SSLMode", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The mode to enable or disable SSL when Firehose connects to the database endpoint. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Databases":{ "shape":"DatabaseList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The list of database patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Tables":{ "shape":"DatabaseTableList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The list of table patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Columns":{ "shape":"DatabaseColumnList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The list of column patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "SurrogateKeys":{ "shape":"DatabaseColumnIncludeOrExcludeList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "SnapshotWatermarkTable":{ "shape":"DatabaseTableName", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "SnapshotInfo":{ "shape":"DatabaseSnapshotInfoList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The structure that describes the snapshot information of a table in source database endpoint that Firehose reads. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseSourceAuthenticationConfiguration":{ "shape":"DatabaseSourceAuthenticationConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The structure to configure the authentication methods for Firehose to connect to source database endpoint. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseSourceVPCConfiguration":{ "shape":"DatabaseSourceVPCConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The top level object for database source description. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseSourceVPCConfiguration":{ "type":"structure", @@ -1093,10 +1097,10 @@ "members":{ "VpcEndpointServiceName":{ "shape":"VpcEndpointServiceName", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The VPC endpoint service name which Firehose uses to create a PrivateLink to the database. The endpoint service must have the Firehose service principle <code>firehose.amazonaws.com</code> as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like <code>com.amazonaws.vpce.<region>.<vpc-endpoint-service-id></code>. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseSurrogateKeyList":{ "type":"list", @@ -1111,14 +1115,14 @@ "members":{ "Include":{ "shape":"DatabaseTableIncludeOrExcludeList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The list of table patterns in source database endpoint to be included for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Exclude":{ "shape":"DatabaseTableIncludeOrExcludeList", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The list of table patterns in source database endpoint to be excluded for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The structure used to configure the list of table patterns in source database endpoint for Firehose to read from. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "DatabaseTableName":{ "type":"string", @@ -1403,7 +1407,7 @@ }, "ElasticsearchDestinationDescription":{ "shape":"ElasticsearchDestinationDescription", - "documentation":"<p>The destination in Amazon ES.</p>" + "documentation":"<p>The destination in Amazon OpenSearch Service.</p>" }, "AmazonopensearchserviceDestinationDescription":{ "shape":"AmazonopensearchserviceDestinationDescription", @@ -1463,7 +1467,7 @@ }, "PartitionSpec":{ "shape":"PartitionSpec", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The partition spec configuration for a table that is used by automatic table creation.</p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "S3ErrorOutputPrefix":{ "shape":"ErrorOutputPrefix", @@ -1476,6 +1480,27 @@ "type":"list", "member":{"shape":"DestinationTableConfiguration"} }, + "DirectPutSourceConfiguration":{ + "type":"structure", + "required":["ThroughputHintInMBs"], + "members":{ + "ThroughputHintInMBs":{ + "shape":"ThroughputHintInMBs", + "documentation":"<p> The value that you configure for this parameter is for information purpose only and does not affect Firehose delivery throughput limit. You can use the <a href=\"https://support.console.aws.amazon.com/support/home#/case/create%3FissueType=service-limit-increase%26limitType=kinesis-firehose-limits\">Firehose Limits form</a> to request a throughput limit increase. </p>" + } + }, + "documentation":"<p>The structure that configures parameters such as <code>ThroughputHintInMBs</code> for a stream configured with Direct PUT as a source. </p>" + }, + "DirectPutSourceDescription":{ + "type":"structure", + "members":{ + "ThroughputHintInMBs":{ + "shape":"ThroughputHintInMBs", + "documentation":"<p> The value that you configure for this parameter is for information purpose only and does not affect Firehose delivery throughput limit. You can use the <a href=\"https://support.console.aws.amazon.com/support/home#/case/create%3FissueType=service-limit-increase%26limitType=kinesis-firehose-limits\">Firehose Limits form</a> to request a throughput limit increase. </p>" + } + }, + "documentation":"<p>The structure that configures parameters such as <code>ThroughputHintInMBs</code> for a stream configured with Direct PUT as a source. </p>" + }, "DocumentIdOptions":{ "type":"structure", "required":["DefaultDocumentIdFormat"], @@ -1496,7 +1521,7 @@ }, "Enabled":{ "shape":"BooleanObject", - "documentation":"<p>Specifies that the dynamic partitioning is enabled for this Firehose Firehose stream.</p>" + "documentation":"<p>Specifies that the dynamic partitioning is enabled for this Firehose stream.</p>" } }, "documentation":"<p>The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations. </p>" @@ -1513,7 +1538,7 @@ "documentation":"<p>Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.</p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the Firehose stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.</p>" } }, - "documentation":"<p>Describes the buffering to perform before delivering data to the Amazon ES destination.</p>" + "documentation":"<p>Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.</p>" }, "ElasticsearchBufferingIntervalInSeconds":{ "type":"integer", @@ -1541,11 +1566,11 @@ "members":{ "RoleARN":{ "shape":"RoleARN", - "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant 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 Amazon Web Services Service Namespaces</a>.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant 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 Amazon Web Services Service Namespaces</a>.</p>" }, "DomainARN":{ "shape":"ElasticsearchDomainARN", - "documentation":"<p>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeDomain</code>, <code>DescribeDomains</code>, and <code>DescribeDomainConfig</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 Amazon Web Services Service Namespaces</a>.</p> <p>Specify either <code>ClusterEndpoint</code> or <code>DomainARN</code>.</p>" + "documentation":"<p>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for <code>DescribeDomain</code>, <code>DescribeDomains</code>, and <code>DescribeDomainConfig</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 Amazon Web Services Service Namespaces</a>.</p> <p>Specify either <code>ClusterEndpoint</code> or <code>DomainARN</code>.</p>" }, "ClusterEndpoint":{ "shape":"ElasticsearchClusterEndpoint", @@ -1561,7 +1586,7 @@ }, "IndexRotationPeriod":{ "shape":"ElasticsearchIndexRotationPeriod", - "documentation":"<p>The Elasticsearch index rotation period. Index rotation appends a timestamp to the <code>IndexName</code> to facilitate the expiration of old data. For more information, see <a href=\"https://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 timestamp to the <code>IndexName</code> to facilitate the expiration of old data. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for the Amazon OpenSearch Service Destination</a>. The default value is <code>OneDay</code>.</p>" }, "BufferingHints":{ "shape":"ElasticsearchBufferingHints", @@ -1569,11 +1594,11 @@ }, "RetryOptions":{ "shape":"ElasticsearchRetryOptions", - "documentation":"<p>The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).</p>" + "documentation":"<p>The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).</p>" }, "S3BackupMode":{ "shape":"ElasticsearchS3BackupMode", - "documentation":"<p>Defines how documents should be delivered to Amazon S3. When it is set to <code>FailedDocumentsOnly</code>, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with <code>AmazonOpenSearchService-failed/</code> appended to the key prefix. When set to <code>AllDocuments</code>, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with <code>AmazonOpenSearchService-failed/</code> appended to the prefix. For more information, see <a href=\"https://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> <p>You can't change this backup mode after you create the Firehose stream. </p>" + "documentation":"<p>Defines how documents should be delivered to Amazon S3. When it is set to <code>FailedDocumentsOnly</code>, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with <code>AmazonOpenSearchService-failed/</code> appended to the key prefix. When set to <code>AllDocuments</code>, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with <code>AmazonOpenSearchService-failed/</code> appended to the prefix. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup\">Amazon S3 Backup for the Amazon OpenSearch Service Destination</a>. Default value is <code>FailedDocumentsOnly</code>.</p> <p>You can't change this backup mode after you create the Firehose stream. </p>" }, "S3Configuration":{ "shape":"S3DestinationConfiguration", @@ -1596,7 +1621,7 @@ "documentation":"<p>Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.</p>" } }, - "documentation":"<p>Describes the configuration of a destination in Amazon ES.</p>" + "documentation":"<p>Describes the configuration of a destination in Amazon OpenSearch Service.</p>" }, "ElasticsearchDestinationDescription":{ "type":"structure", @@ -1607,11 +1632,11 @@ }, "DomainARN":{ "shape":"ElasticsearchDomainARN", - "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 Amazon Web Services Service Namespaces</a>.</p> <p>Firehose uses either <code>ClusterEndpoint</code> or <code>DomainARN</code> to send data to Amazon ES.</p>" + "documentation":"<p>The ARN of the Amazon OpenSearch Service 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 Amazon Web Services Service Namespaces</a>.</p> <p>Firehose uses either <code>ClusterEndpoint</code> or <code>DomainARN</code> to send data to Amazon OpenSearch Service.</p>" }, "ClusterEndpoint":{ "shape":"ElasticsearchClusterEndpoint", - "documentation":"<p>The endpoint to use when communicating with the cluster. Firehose uses either this <code>ClusterEndpoint</code> or the <code>DomainARN</code> field to send data to Amazon ES.</p>" + "documentation":"<p>The endpoint to use when communicating with the cluster. Firehose uses either this <code>ClusterEndpoint</code> or the <code>DomainARN</code> field to send data to Amazon OpenSearch Service.</p>" }, "IndexName":{ "shape":"ElasticsearchIndexName", @@ -1631,7 +1656,7 @@ }, "RetryOptions":{ "shape":"ElasticsearchRetryOptions", - "documentation":"<p>The Amazon ES retry options.</p>" + "documentation":"<p>The Amazon OpenSearch Service retry options.</p>" }, "S3BackupMode":{ "shape":"ElasticsearchS3BackupMode", @@ -1658,18 +1683,18 @@ "documentation":"<p>Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.</p>" } }, - "documentation":"<p>The destination description in Amazon ES.</p>" + "documentation":"<p>The destination description in Amazon OpenSearch Service.</p>" }, "ElasticsearchDestinationUpdate":{ "type":"structure", "members":{ "RoleARN":{ "shape":"RoleARN", - "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant 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 Amazon Web Services Service Namespaces</a>.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant 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 Amazon Web Services Service Namespaces</a>.</p>" }, "DomainARN":{ "shape":"ElasticsearchDomainARN", - "documentation":"<p>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeDomain</code>, <code>DescribeDomains</code>, and <code>DescribeDomainConfig</code> after assuming the IAM role specified in <code>RoleARN</code>. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p> <p>Specify either <code>ClusterEndpoint</code> or <code>DomainARN</code>.</p>" + "documentation":"<p>The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for <code>DescribeDomain</code>, <code>DescribeDomains</code>, and <code>DescribeDomainConfig</code> after assuming the IAM role specified in <code>RoleARN</code>. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p> <p>Specify either <code>ClusterEndpoint</code> or <code>DomainARN</code>.</p>" }, "ClusterEndpoint":{ "shape":"ElasticsearchClusterEndpoint", @@ -1685,7 +1710,7 @@ }, "IndexRotationPeriod":{ "shape":"ElasticsearchIndexRotationPeriod", - "documentation":"<p>The Elasticsearch index rotation period. Index rotation appends a timestamp to <code>IndexName</code> to facilitate the expiration of old data. For more information, see <a href=\"https://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 timestamp to <code>IndexName</code> to facilitate the expiration of old data. For more information, see <a href=\"https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for the Amazon OpenSearch Service Destination</a>. Default value is <code>OneDay</code>.</p>" }, "BufferingHints":{ "shape":"ElasticsearchBufferingHints", @@ -1693,7 +1718,7 @@ }, "RetryOptions":{ "shape":"ElasticsearchRetryOptions", - "documentation":"<p>The retry behavior in case Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).</p>" + "documentation":"<p>The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).</p>" }, "S3Update":{ "shape":"S3DestinationUpdate", @@ -1712,7 +1737,7 @@ "documentation":"<p>Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.</p>" } }, - "documentation":"<p>Describes an update for a destination in Amazon ES.</p>" + "documentation":"<p>Describes an update for a destination in Amazon OpenSearch Service.</p>" }, "ElasticsearchDomainARN":{ "type":"string", @@ -1746,10 +1771,10 @@ "members":{ "DurationInSeconds":{ "shape":"ElasticsearchRetryDurationInSeconds", - "documentation":"<p>After an initial failure to deliver to Amazon ES, the total amount of time during which 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>After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which 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 Firehose is unable to deliver documents to Amazon ES.</p>" + "documentation":"<p>Configures retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service.</p>" }, "ElasticsearchS3BackupMode":{ "type":"string", @@ -2339,11 +2364,11 @@ }, "SchemaEvolutionConfiguration":{ "shape":"SchemaEvolutionConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The configuration to enable automatic schema evolution.</p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "TableCreationConfiguration":{ "shape":"TableCreationConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The configuration to enable automatic table creation.</p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "BufferingHints":{"shape":"BufferingHints"}, "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, @@ -2357,6 +2382,10 @@ "shape":"RoleARN", "documentation":"<p> The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables. </p>" }, + "AppendOnly":{ + "shape":"BooleanObject", + "documentation":"<p> Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.</p> <p>The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery. </p>" + }, "CatalogConfiguration":{ "shape":"CatalogConfiguration", "documentation":"<p> Configuration describing where the destination Apache Iceberg Tables are persisted. </p>" @@ -2374,11 +2403,11 @@ }, "SchemaEvolutionConfiguration":{ "shape":"SchemaEvolutionConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The description of automatic schema evolution configuration.</p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "TableCreationConfiguration":{ "shape":"TableCreationConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The description of table creation configuration. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "BufferingHints":{"shape":"BufferingHints"}, "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, @@ -2392,6 +2421,10 @@ "shape":"RoleARN", "documentation":"<p> The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables. </p>" }, + "AppendOnly":{ + "shape":"BooleanObject", + "documentation":"<p> Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables.</p> <p>The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery.</p> <p> </p>" + }, "CatalogConfiguration":{ "shape":"CatalogConfiguration", "documentation":"<p> Configuration describing where the destination Iceberg tables are persisted. </p>" @@ -2409,11 +2442,11 @@ }, "SchemaEvolutionConfiguration":{ "shape":"SchemaEvolutionConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The configuration to enable automatic schema evolution. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "TableCreationConfiguration":{ "shape":"TableCreationConfiguration", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The configuration to enable automatic table creation. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "BufferingHints":{"shape":"BufferingHints"}, "CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}, @@ -2427,6 +2460,10 @@ "shape":"RoleARN", "documentation":"<p> The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling Apache Iceberg Tables. </p>" }, + "AppendOnly":{ + "shape":"BooleanObject", + "documentation":"<p> Describes whether all incoming data for this delivery stream will be append only (inserts only and not for updates and deletes) for Iceberg delivery. This feature is only applicable for Apache Iceberg Tables. </p> <p>The default value is false. If you set this value to true, Firehose automatically increases the throughput limit of a stream based on the throttling levels of the stream. If you set this parameter to true for a stream with updates and deletes, you will see out of order delivery. </p>" + }, "CatalogConfiguration":{ "shape":"CatalogConfiguration", "documentation":"<p> Configuration describing where the destination Iceberg tables are persisted. </p>" @@ -2544,7 +2581,7 @@ "documentation":"<p>Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.</p>" } }, - "documentation":"<p>Details about a Kinesis data stream used as the source for a Firehose Firehose stream.</p>" + "documentation":"<p>Details about a Kinesis data stream used as the source for a Firehose stream.</p>" }, "LimitExceededException":{ "type":"structure", @@ -2719,7 +2756,7 @@ "documentation":"<p>The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active. </p> <p>If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the <code>ReadFromTimestampUTC</code> parameter to Epoch (1970-01-01T00:00:00Z). </p>" } }, - "documentation":"<p>Details about the Amazon MSK cluster used as the source for a Firehose Firehose stream.</p>" + "documentation":"<p>Details about the Amazon MSK cluster used as the source for a Firehose stream.</p>" }, "NoEncryptionConfig":{ "type":"string", @@ -2893,10 +2930,10 @@ "members":{ "SourceName":{ "shape":"NonEmptyStringWithoutWhitespace", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> The column name to be configured in partition spec. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>Represents a single field in a <code>PartitionSpec</code>. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "PartitionFields":{ "type":"list", @@ -2907,10 +2944,10 @@ "members":{ "Identity":{ "shape":"PartitionFields", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> List of identity <a href=\"https://iceberg.apache.org/spec/#partition-transforms\">transforms</a> that performs an identity transformation. The transform takes the source value, and does not modify it. Result type is the source type.</p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>Represents how to produce partition data for a table. Partition data is produced by transforming columns in a table. Each column transform is represented by a named <code>PartitionField</code>. </p> <p>Here is an example of the schema in JSON. </p> <p> <code>\"partitionSpec\": { \"identity\": [ {\"sourceName\": \"column1\"}, {\"sourceName\": \"column2\"}, {\"sourceName\": \"column3\"} ] }</code> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Password":{ "type":"string", @@ -3543,10 +3580,10 @@ "members":{ "Enabled":{ "shape":"BooleanObject", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> Specify whether you want to enable schema evolution. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The configuration to enable schema evolution.</p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "SecretARN":{ "type":"string", @@ -3584,14 +3621,14 @@ "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>" + "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/docs/contribution-guidelines/\">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 Firehose to use to convert data to the target format before writing it to Amazon S3. 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>" + "documentation":"<p>The serializer that you want Firehose to use to convert data to the target format before writing it to Amazon S3. Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe.</p>" }, "ServiceUnavailableException":{ "type":"structure", @@ -3725,11 +3762,11 @@ }, "MetaDataColumnName":{ "shape":"SnowflakeMetaDataColumnName", - "documentation":"<p>The name of the record metadata column</p>" + "documentation":"<p>Specify a column name in the table, where the metadata information has to be loaded. When you enable this field, you will see the following column in the snowflake table, which differs based on the source type.</p> <p>For Direct PUT as source </p> <p> <code>{ \"firehoseDeliveryStreamName\" : \"streamname\", \"IngestionTime\" : \"timestamp\" }</code> </p> <p>For Kinesis Data Stream as source </p> <p> <code> \"kinesisStreamName\" : \"streamname\", \"kinesisShardId\" : \"Id\", \"kinesisPartitionKey\" : \"key\", \"kinesisSequenceNumber\" : \"1234\", \"subsequenceNumber\" : \"2334\", \"IngestionTime\" : \"timestamp\" }</code> </p>" }, "ContentColumnName":{ "shape":"SnowflakeContentColumnName", - "documentation":"<p>The name of the record content column</p>" + "documentation":"<p>The name of the record content column.</p>" }, "SnowflakeVpcConfiguration":{ "shape":"SnowflakeVpcConfiguration", @@ -4003,6 +4040,10 @@ "SourceDescription":{ "type":"structure", "members":{ + "DirectPutSourceDescription":{ + "shape":"DirectPutSourceDescription", + "documentation":"<p>Details about Direct PUT used as the source for a Firehose stream. </p>" + }, "KinesisStreamSourceDescription":{ "shape":"KinesisStreamSourceDescription", "documentation":"<p>The <a>KinesisStreamSourceDescription</a> value for the source Kinesis data stream.</p>" @@ -4013,10 +4054,10 @@ }, "DatabaseSourceDescription":{ "shape":"DatabaseSourceDescription", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>Details about a database used as the source for a Firehose stream.</p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p>Details about a Kinesis data stream used as the source for a Firehose Firehose stream.</p>" + "documentation":"<p>Details about a Kinesis data stream used as the source for a Firehose stream.</p>" }, "SplunkBufferingHints":{ "type":"structure", @@ -4271,10 +4312,10 @@ "members":{ "Enabled":{ "shape":"BooleanObject", - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p> Specify whether you want to enable automatic table creation. </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" } }, - "documentation":"<p> </p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" + "documentation":"<p>The configuration to enable automatic table creation.</p> <p>Amazon Data Firehose is in preview release and is subject to change.</p>" }, "Tag":{ "type":"structure", @@ -4337,6 +4378,11 @@ "min":0, "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*$" }, + "ThroughputHintInMBs":{ + "type":"integer", + "max":100, + "min":1 + }, "Timestamp":{"type":"timestamp"}, "TopicName":{ "type":"string", @@ -4401,7 +4447,7 @@ }, "ElasticsearchDestinationUpdate":{ "shape":"ElasticsearchDestinationUpdate", - "documentation":"<p>Describes an update for a destination in Amazon ES.</p>" + "documentation":"<p>Describes an update for a destination in Amazon OpenSearch Service.</p>" }, "AmazonopensearchserviceDestinationUpdate":{ "shape":"AmazonopensearchserviceDestinationUpdate", @@ -4451,7 +4497,7 @@ "members":{ "SubnetIds":{ "shape":"SubnetIdList", - "documentation":"<p>The IDs of the subnets that you want Firehose to use to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.</p> <p>The number of ENIs that Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Firehose can create up to three ENIs for this Firehose stream for each of the subnets specified here. For more information about ENI quota, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis\">Network Interfaces </a> in the Amazon VPC Quotas topic.</p>" + "documentation":"<p>The IDs of the subnets that you want Firehose to use to create ENIs in the VPC of the Amazon OpenSearch Service destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon OpenSearch Service endpoints. Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.</p> <p>The number of ENIs that Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Firehose can create up to three ENIs for this Firehose stream for each of the subnets specified here. For more information about ENI quota, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis\">Network Interfaces </a> in the Amazon VPC Quotas topic.</p>" }, "RoleARN":{ "shape":"RoleARN", @@ -4459,7 +4505,7 @@ }, "SecurityGroupIds":{ "shape":"SecurityGroupIdList", - "documentation":"<p>The IDs of the security groups that you want Firehose to use when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules\">Security group rules</a> in the Amazon VPC documentation.</p>" + "documentation":"<p>The IDs of the security groups that you want Firehose to use when it creates ENIs in the VPC of the Amazon OpenSearch Service destination. You can use the same security group that the Amazon OpenSearch Service domain uses or different ones. If you specify different security groups here, ensure that they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain's security group. Also ensure that the Amazon OpenSearch Service domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your delivery stream and the Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules\">Security group rules</a> in the Amazon VPC documentation.</p>" } }, "documentation":"<p>The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.</p>" @@ -4475,7 +4521,7 @@ "members":{ "SubnetIds":{ "shape":"SubnetIdList", - "documentation":"<p>The IDs of the subnets that Firehose uses to create ENIs in the VPC of the Amazon ES destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon ES endpoints. Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.</p> <p>The number of ENIs that Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Firehose can create up to three ENIs for this Firehose stream for each of the subnets specified here. For more information about ENI quota, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis\">Network Interfaces </a> in the Amazon VPC Quotas topic.</p>" + "documentation":"<p>The IDs of the subnets that Firehose uses to create ENIs in the VPC of the Amazon OpenSearch Service destination. Make sure that the routing tables and inbound and outbound rules allow traffic to flow from the subnets whose IDs are specified here to the subnets that have the destination Amazon OpenSearch Service endpoints. Firehose creates at least one ENI in each of the subnets that are specified here. Do not delete or modify these ENIs.</p> <p>The number of ENIs that Firehose creates in the subnets specified here scales up and down automatically based on throughput. To enable Firehose to scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To help you calculate the quota you need, assume that Firehose can create up to three ENIs for this Firehose stream for each of the subnets specified here. For more information about ENI quota, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-enis\">Network Interfaces </a> in the Amazon VPC Quotas topic.</p>" }, "RoleARN":{ "shape":"RoleARN", @@ -4483,14 +4529,14 @@ }, "SecurityGroupIds":{ "shape":"SecurityGroupIdList", - "documentation":"<p>The IDs of the security groups that Firehose uses when it creates ENIs in the VPC of the Amazon ES destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your Firehose stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules\">Security group rules</a> in the Amazon VPC documentation.</p>" + "documentation":"<p>The IDs of the security groups that Firehose uses when it creates ENIs in the VPC of the Amazon OpenSearch Service destination. You can use the same security group that the Amazon ES domain uses or different ones. If you specify different security groups, ensure that they allow outbound HTTPS traffic to the Amazon OpenSearch Service domain's security group. Also ensure that the Amazon OpenSearch Service domain's security group allows HTTPS traffic from the security groups specified here. If you use the same security group for both your Firehose stream and the Amazon OpenSearch Service domain, make sure the security group inbound rule allows HTTPS traffic. For more information about security group rules, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html#SecurityGroupRules\">Security group rules</a> in the Amazon VPC documentation.</p>" }, "VpcId":{ "shape":"NonEmptyStringWithoutWhitespace", - "documentation":"<p>The ID of the Amazon ES destination's VPC.</p>" + "documentation":"<p>The ID of the Amazon OpenSearch Service destination's VPC.</p>" } }, - "documentation":"<p>The details of the VPC of the Amazon ES destination.</p>" + "documentation":"<p>The details of the VPC of the Amazon OpenSearch Service destination.</p>" }, "VpcEndpointServiceName":{ "type":"string", diff --git a/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/paginators-1.json b/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/paginators-1.json index ea142457a6a..740e56e299a 100644 --- a/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/paginators-1.json @@ -1,3 +1,40 @@ { - "pagination": {} + "pagination": { + "ListActions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "actions" + }, + "ListExperimentResolvedTargets": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "resolvedTargets" + }, + "ListExperimentTemplates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "experimentTemplates" + }, + "ListExperiments": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "experiments" + }, + "ListTargetAccountConfigurations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "targetAccountConfigurations" + }, + "ListTargetResourceTypes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "targetResourceTypes" + } + } } diff --git a/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/service-2.json b/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/service-2.json index 2e7a5167a6d..eb08ec09e46 100644 --- a/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/fis/2020-12-01/service-2.json @@ -1220,7 +1220,7 @@ "documentation":"<p>The name of the S3 bucket where the experiment report will be stored.</p>" }, "prefix":{ - "shape":"S3ObjectKey", + "shape":"ReportConfigurationS3OutputPrefix", "documentation":"<p>The prefix of the S3 bucket where the experiment report will be stored.</p>" } }, @@ -2510,7 +2510,7 @@ "documentation":"<p>The name of the S3 bucket where the experiment report will be stored.</p>" }, "prefix":{ - "shape":"S3ObjectKey", + "shape":"ReportConfigurationS3OutputPrefix", "documentation":"<p>The prefix of the S3 bucket where the experiment report will be stored.</p>" } }, @@ -2524,12 +2524,17 @@ "documentation":"<p>The name of the S3 bucket where the experiment report will be stored.</p>" }, "prefix":{ - "shape":"S3ObjectKey", + "shape":"ReportConfigurationS3OutputPrefix", "documentation":"<p>The prefix of the S3 bucket where the experiment report will be stored.</p>" } }, "documentation":"<p>Specifies the S3 destination for the experiment report.</p>" }, + "ReportConfigurationS3OutputPrefix":{ + "type":"string", + "max":256, + "pattern":"[\\S]+" + }, "ResolvedTarget":{ "type":"structure", "members":{ @@ -2586,7 +2591,7 @@ }, "S3ObjectKey":{ "type":"string", - "max":1024, + "max":700, "min":1, "pattern":"[\\s\\S]+" }, diff --git a/contrib/python/botocore/py3/botocore/data/fsx/2018-03-01/service-2.json b/contrib/python/botocore/py3/botocore/data/fsx/2018-03-01/service-2.json index fc694300260..911d7279456 100644 --- a/contrib/python/botocore/py3/botocore/data/fsx/2018-03-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/fsx/2018-03-01/service-2.json @@ -45,7 +45,7 @@ {"shape":"DataRepositoryTaskEnded"}, {"shape":"InternalServerError"} ], - "documentation":"<p>Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the <code>PENDING</code> or <code>EXECUTING</code> state. When you cancel am export task, Amazon FSx does the following.</p> <ul> <li> <p>Any files that FSx has already exported are not reverted.</p> </li> <li> <p>FSx continues to export any files that are in-flight when the cancel operation is received.</p> </li> <li> <p>FSx does not export any files that have not yet been exported.</p> </li> </ul> <p>For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.</p>", + "documentation":"<p>Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the <code>PENDING</code> or <code>EXECUTING</code> state. When you cancel an export task, Amazon FSx does the following.</p> <ul> <li> <p>Any files that FSx has already exported are not reverted.</p> </li> <li> <p>FSx continues to export any files that are in-flight when the cancel operation is received.</p> </li> <li> <p>FSx does not export any files that have not yet been exported.</p> </li> </ul> <p>For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.</p>", "idempotent":true }, "CopyBackup":{ @@ -166,7 +166,7 @@ {"shape":"InternalServerError"}, {"shape":"MissingFileCacheConfiguration"} ], - "documentation":"<p>Creates a new Amazon File Cache resource.</p> <p>You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, <code>CreateFileCache</code> returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns <code>IncompatibleParameterError</code>. If a file cache with the specified client request token doesn't exist, <code>CreateFileCache</code> does the following: </p> <ul> <li> <p>Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the cache in JSON format.</p> </li> </ul> <note> <p>The <code>CreateFileCache</code> call returns while the cache's lifecycle state is still <code>CREATING</code>. You can check the cache creation status by calling the <a href=\"https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html\">DescribeFileCaches</a> operation, which returns the cache state along with other information.</p> </note>", + "documentation":"<p>Creates a new Amazon File Cache resource.</p> <p>You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, <code>CreateFileCache</code> returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns <code>IncompatibleParameterError</code>. If a file cache with the specified client request token doesn't exist, <code>CreateFileCache</code> does the following: </p> <ul> <li> <p>Creates a new, empty Amazon File Cache resource with an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the cache in JSON format.</p> </li> </ul> <note> <p>The <code>CreateFileCache</code> call returns while the cache's lifecycle state is still <code>CREATING</code>. You can check the cache creation status by calling the <a href=\"https://docs.aws.amazon.com/fsx/latest/APIReference/API_DescribeFileCaches.html\">DescribeFileCaches</a> operation, which returns the cache state along with other information.</p> </note>", "idempotent":true }, "CreateFileSystem":{ @@ -740,7 +740,7 @@ {"shape":"MissingFileSystemConfiguration"}, {"shape":"ServiceLimitExceeded"} ], - "documentation":"<p>Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.</p> <p>For FSx for Windows File Server file systems, you can update the following properties:</p> <ul> <li> <p> <code>AuditLogConfiguration</code> </p> </li> <li> <p> <code>AutomaticBackupRetentionDays</code> </p> </li> <li> <p> <code>DailyAutomaticBackupStartTime</code> </p> </li> <li> <p> <code>SelfManagedActiveDirectoryConfiguration</code> </p> </li> <li> <p> <code>StorageCapacity</code> </p> </li> <li> <p> <code>StorageType</code> </p> </li> <li> <p> <code>ThroughputCapacity</code> </p> </li> <li> <p> <code>DiskIopsConfiguration</code> </p> </li> <li> <p> <code>WeeklyMaintenanceStartTime</code> </p> </li> </ul> <p>For FSx for Lustre file systems, you can update the following properties:</p> <ul> <li> <p> <code>AutoImportPolicy</code> </p> </li> <li> <p> <code>AutomaticBackupRetentionDays</code> </p> </li> <li> <p> <code>DailyAutomaticBackupStartTime</code> </p> </li> <li> <p> <code>DataCompressionType</code> </p> </li> <li> <p> <code>LogConfiguration</code> </p> </li> <li> <p> <code>LustreRootSquashConfiguration</code> </p> </li> <li> <p> <code>MetadataConfiguration</code> </p> </li> <li> <p> <code>PerUnitStorageThroughput</code> </p> </li> <li> <p> <code>StorageCapacity</code> </p> </li> <li> <p> <code>WeeklyMaintenanceStartTime</code> </p> </li> </ul> <p>For FSx for ONTAP file systems, you can update the following properties:</p> <ul> <li> <p> <code>AddRouteTableIds</code> </p> </li> <li> <p> <code>AutomaticBackupRetentionDays</code> </p> </li> <li> <p> <code>DailyAutomaticBackupStartTime</code> </p> </li> <li> <p> <code>DiskIopsConfiguration</code> </p> </li> <li> <p> <code>FsxAdminPassword</code> </p> </li> <li> <p> <code>HAPairs</code> </p> </li> <li> <p> <code>RemoveRouteTableIds</code> </p> </li> <li> <p> <code>StorageCapacity</code> </p> </li> <li> <p> <code>ThroughputCapacity</code> </p> </li> <li> <p> <code>ThroughputCapacityPerHAPair</code> </p> </li> <li> <p> <code>WeeklyMaintenanceStartTime</code> </p> </li> </ul> <p>For FSx for OpenZFS file systems, you can update the following properties:</p> <ul> <li> <p> <code>AddRouteTableIds</code> </p> </li> <li> <p> <code>AutomaticBackupRetentionDays</code> </p> </li> <li> <p> <code>CopyTagsToBackups</code> </p> </li> <li> <p> <code>CopyTagsToVolumes</code> </p> </li> <li> <p> <code>DailyAutomaticBackupStartTime</code> </p> </li> <li> <p> <code>DiskIopsConfiguration</code> </p> </li> <li> <p> <code>ReadCacheConfiguration</code> </p> </li> <li> <p> <code>RemoveRouteTableIds</code> </p> </li> <li> <p> <code>StorageCapacity</code> </p> </li> <li> <p> <code>ThroughputCapacity</code> </p> </li> <li> <p> <code>WeeklyMaintenanceStartTime</code> </p> </li> </ul>" + "documentation":"<p>Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.</p> <p>For FSx for Windows File Server file systems, you can update the following properties:</p> <ul> <li> <p> <code>AuditLogConfiguration</code> </p> </li> <li> <p> <code>AutomaticBackupRetentionDays</code> </p> </li> <li> <p> <code>DailyAutomaticBackupStartTime</code> </p> </li> <li> <p> <code>SelfManagedActiveDirectoryConfiguration</code> </p> </li> <li> <p> <code>StorageCapacity</code> </p> </li> <li> <p> <code>StorageType</code> </p> </li> <li> <p> <code>ThroughputCapacity</code> </p> </li> <li> <p> <code>DiskIopsConfiguration</code> </p> </li> <li> <p> <code>WeeklyMaintenanceStartTime</code> </p> </li> </ul> <p>For FSx for Lustre file systems, you can update the following properties:</p> <ul> <li> <p> <code>AutoImportPolicy</code> </p> </li> <li> <p> <code>AutomaticBackupRetentionDays</code> </p> </li> <li> <p> <code>DailyAutomaticBackupStartTime</code> </p> </li> <li> <p> <code>DataCompressionType</code> </p> </li> <li> <p> <code>FileSystemTypeVersion</code> </p> </li> <li> <p> <code>LogConfiguration</code> </p> </li> <li> <p> <code>LustreRootSquashConfiguration</code> </p> </li> <li> <p> <code>MetadataConfiguration</code> </p> </li> <li> <p> <code>PerUnitStorageThroughput</code> </p> </li> <li> <p> <code>StorageCapacity</code> </p> </li> <li> <p> <code>WeeklyMaintenanceStartTime</code> </p> </li> </ul> <p>For FSx for ONTAP file systems, you can update the following properties:</p> <ul> <li> <p> <code>AddRouteTableIds</code> </p> </li> <li> <p> <code>AutomaticBackupRetentionDays</code> </p> </li> <li> <p> <code>DailyAutomaticBackupStartTime</code> </p> </li> <li> <p> <code>DiskIopsConfiguration</code> </p> </li> <li> <p> <code>FsxAdminPassword</code> </p> </li> <li> <p> <code>HAPairs</code> </p> </li> <li> <p> <code>RemoveRouteTableIds</code> </p> </li> <li> <p> <code>StorageCapacity</code> </p> </li> <li> <p> <code>ThroughputCapacity</code> </p> </li> <li> <p> <code>ThroughputCapacityPerHAPair</code> </p> </li> <li> <p> <code>WeeklyMaintenanceStartTime</code> </p> </li> </ul> <p>For FSx for OpenZFS file systems, you can update the following properties:</p> <ul> <li> <p> <code>AddRouteTableIds</code> </p> </li> <li> <p> <code>AutomaticBackupRetentionDays</code> </p> </li> <li> <p> <code>CopyTagsToBackups</code> </p> </li> <li> <p> <code>CopyTagsToVolumes</code> </p> </li> <li> <p> <code>DailyAutomaticBackupStartTime</code> </p> </li> <li> <p> <code>DiskIopsConfiguration</code> </p> </li> <li> <p> <code>ReadCacheConfiguration</code> </p> </li> <li> <p> <code>RemoveRouteTableIds</code> </p> </li> <li> <p> <code>StorageCapacity</code> </p> </li> <li> <p> <code>ThroughputCapacity</code> </p> </li> <li> <p> <code>WeeklyMaintenanceStartTime</code> </p> </li> </ul>" }, "UpdateSharedVpcConfiguration":{ "name":"UpdateSharedVpcConfiguration", @@ -1681,7 +1681,7 @@ "KmsKeyId":{"shape":"KmsKeyId"}, "FileSystemTypeVersion":{ "shape":"FileSystemTypeVersion", - "documentation":"<p>Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are <code>2.10</code>, <code>2.12</code>, and <code>2.15</code>.</p> <p>You don't need to specify <code>FileSystemTypeVersion</code> because it will be applied using the backup's <code>FileSystemTypeVersion</code> setting. If you choose to specify <code>FileSystemTypeVersion</code> when creating from backup, the value must match the backup's <code>FileSystemTypeVersion</code> setting.</p>" + "documentation":"<p>Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are <code>2.10</code>, <code>2.12</code>, and <code>2.15</code>.</p> <p>You can enter a Lustre version that is newer than the backup's <code>FileSystemTypeVersion</code> setting. If you don't enter a newer Lustre version, it defaults to the backup's setting.</p>" }, "OpenZFSConfiguration":{ "shape":"CreateFileSystemOpenZFSConfiguration", @@ -1689,7 +1689,7 @@ }, "StorageCapacity":{ "shape":"StorageCapacity", - "documentation":"<p>Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the <code>StorageCapacity</code> parameter, the default is the backup's <code>StorageCapacity</code> value.</p> <p>If used to create a file system other than OpenZFS, you must provide a value that matches the backup's <code>StorageCapacity</code> value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request. </p>" + "documentation":"<p>Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the <code>StorageCapacity</code> parameter, the default is the backup's <code>StorageCapacity</code> value.</p> <p>If used to create a file system other than OpenZFS, you must provide a value that matches the backup's <code>StorageCapacity</code> value. If you provide any other value, Amazon FSx responds with an HTTP status code 400 Bad Request. </p>" } }, "documentation":"<p>The request object for the <code>CreateFileSystemFromBackup</code> operation.</p>" @@ -2089,7 +2089,7 @@ }, "RecordSizeKiB":{ "shape":"IntegerRecordSizeKiB", - "documentation":"<p>Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 2048 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see <a href=\"https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance\"> ZFS Record size</a> in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>" + "documentation":"<p>Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see <a href=\"https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance\"> ZFS Record size</a> in the <i>Amazon FSx for OpenZFS User Guide</i>.</p>" }, "DataCompressionType":{ "shape":"OpenZFSDataCompressionType", @@ -2551,7 +2551,7 @@ "documentation":"<p>Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.</p>" } }, - "documentation":"<p>(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter <code>Name</code>, and one or more <code>Values</code> for the filter.</p>" + "documentation":"<p>(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter <code>Name</code>, and one or more <code>Values</code> for the filter.</p>" }, "DataRepositoryTaskFilterName":{ "type":"string", @@ -4770,7 +4770,7 @@ }, "StorageCapacityQuotaGiB":{ "shape":"IntegerNoMax", - "documentation":"<p>The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.</p>" + "documentation":"<p>The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.</p>" }, "RecordSizeKiB":{ "shape":"IntegerRecordSizeKiB", @@ -5925,7 +5925,7 @@ "DailyAutomaticBackupStartTime":{"shape":"DailyTime"}, "FsxAdminPassword":{ "shape":"AdminPassword", - "documentation":"<p>Update the password for the <code>fsxadmin</code> user by entering a new password. You use the <code>fsxadmin</code> user to access the NetApp ONTAP CLI and REST API to manage your file system resources. For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html\">Managing resources using NetApp Applicaton</a>.</p>" + "documentation":"<p>Update the password for the <code>fsxadmin</code> user by entering a new password. You use the <code>fsxadmin</code> user to access the NetApp ONTAP CLI and REST API to manage your file system resources. For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html\">Managing resources using NetApp Application</a>.</p>" }, "WeeklyMaintenanceStartTime":{"shape":"WeeklyTime"}, "DiskIopsConfiguration":{ @@ -6016,7 +6016,11 @@ "shape":"UpdateFileSystemOpenZFSConfiguration", "documentation":"<p>The configuration updates for an FSx for OpenZFS file system.</p>" }, - "StorageType":{"shape":"StorageType"} + "StorageType":{"shape":"StorageType"}, + "FileSystemTypeVersion":{ + "shape":"FileSystemTypeVersion", + "documentation":"<p>The Lustre version you are updating an FSx for Lustre file system to. Valid values are <code>2.12</code> and <code>2.15</code>. The value you choose must be newer than the file system's current Lustre version.</p>" + } }, "documentation":"<p>The request object for the <code>UpdateFileSystem</code> operation.</p>" }, diff --git a/contrib/python/botocore/py3/botocore/data/geo-routes/2020-11-19/service-2.json b/contrib/python/botocore/py3/botocore/data/geo-routes/2020-11-19/service-2.json index d1e82788424..26c62610e1e 100644 --- a/contrib/python/botocore/py3/botocore/data/geo-routes/2020-11-19/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/geo-routes/2020-11-19/service-2.json @@ -45,7 +45,7 @@ {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Calculates route matrix containing the results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.</p>" + "documentation":"<p> Use <code>CalculateRouteMatrix</code> to compute results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.</p>" }, "CalculateRoutes":{ "name":"CalculateRoutes", @@ -62,7 +62,7 @@ {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Calculates a route given the following required parameters: <code>Origin</code> and <code>Destination</code>.</p>" + "documentation":"<p> <code>CalculateRoutes</code> computes routes given the following required parameters: <code>Origin</code> and <code>Destination</code>.</p>" }, "OptimizeWaypoints":{ "name":"OptimizeWaypoints", @@ -79,7 +79,7 @@ {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.</p>" + "documentation":"<p> <code>OptimizeWaypoints</code> calculates the optimal order to travel between a set of waypoints to minimize either the travel time or the distance travelled during the journey, based on road network restrictions and the traffic pattern data.</p>" }, "SnapToRoads":{ "name":"SnapToRoads", @@ -96,7 +96,7 @@ {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>The SnapToRoads action matches GPS trace to roads most likely traveled on.</p>" + "documentation":"<p> <code>SnapToRoads</code> matches GPS trace to roads most likely traveled on.</p>" } }, "shapes":{ @@ -143,7 +143,7 @@ "members":{ "Allow":{ "shape":"IsolineAllowOptions", - "documentation":"<p>Features that are allowed while calculating. a route</p>" + "documentation":"<p>Features that are allowed while calculating an isoline.</p>" }, "ArrivalTime":{ "shape":"TimestampWithTimezoneOffset", @@ -175,7 +175,7 @@ }, "IsolineGranularity":{ "shape":"IsolineGranularityOptions", - "documentation":"<p>Defines the granularity of the returned Isoline</p>" + "documentation":"<p>Defines the granularity of the returned Isoline.</p>" }, "Key":{ "shape":"ApiKey", @@ -201,7 +201,7 @@ }, "Thresholds":{ "shape":"IsolineThresholds", - "documentation":"<p>Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.</p>" + "documentation":"<p>Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.</p> <p> You incur a calculation charge for each threshold. Using a large amount of thresholds in a request can lead you to incur unexpected charges. See <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`\"> Amazon Location's pricing page</a> for more information.</p>" }, "Traffic":{ "shape":"IsolineTrafficOptions", @@ -267,7 +267,7 @@ "members":{ "Allow":{ "shape":"RouteMatrixAllowOptions", - "documentation":"<p>Features that are allowed while calculating. a route</p>" + "documentation":"<p>Features that are allowed while calculating a route.</p>" }, "Avoid":{ "shape":"RouteMatrixAvoidanceOptions", @@ -283,7 +283,7 @@ }, "Destinations":{ "shape":"CalculateRouteMatrixRequestDestinationsList", - "documentation":"<p>List of destinations for the route.</p>" + "documentation":"<p>List of destinations for the route.</p> <note> <p>Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. See <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`\"> Amazon Location's pricing page</a> for more information.</p> </note>" }, "Exclude":{ "shape":"RouteMatrixExclusionOptions", @@ -301,7 +301,7 @@ }, "Origins":{ "shape":"CalculateRouteMatrixRequestOriginsList", - "documentation":"<p>The position in longitude and latitude for the origin.</p>" + "documentation":"<p>The position in longitude and latitude for the origin.</p> <note> <p>Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. See <a href=\"https://docs.aws.amazon.com/location/latest/developerguide/routes-pricing.html`\"> Amazon Location's pricing page</a> for more information.</p> </note>" }, "RoutingBoundary":{ "shape":"RouteMatrixBoundary", @@ -374,7 +374,7 @@ "members":{ "Allow":{ "shape":"RouteAllowOptions", - "documentation":"<p>Features that are allowed while calculating. a route</p>" + "documentation":"<p>Features that are allowed while calculating a route.</p>" }, "ArrivalTime":{ "shape":"TimestampWithTimezoneOffset", @@ -468,7 +468,7 @@ }, "TravelStepType":{ "shape":"RouteTravelStepType", - "documentation":"<p>Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based naviagtion system.</p>" + "documentation":"<p>Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.</p>" }, "Waypoints":{ "shape":"RouteWaypointList", @@ -536,6 +536,11 @@ "documentation":"<p>Geometry defined as a circle. When request routing boundary was set as <code>AutoCircle</code>, the response routing boundary will return <code>Circle</code> derived from the <code>AutoCircle</code> settings.</p>", "sensitive":true }, + "ClusterIndex":{ + "type":"integer", + "box":true, + "min":0 + }, "Corridor":{ "type":"structure", "required":[ @@ -687,14 +692,14 @@ "members":{ "Hot":{ "shape":"Boolean", - "documentation":"<p>Allow Hot (High Occupancy Toll) lanes while calculating the route.</p>" + "documentation":"<p>Allow Hot (High Occupancy Toll) lanes while calculating an isoline.</p> <p>Default value: <code>false</code> </p>" }, "Hov":{ "shape":"Boolean", - "documentation":"<p>Allow Hov (High Occupancy vehicle) lanes while calculating the route.</p>" + "documentation":"<p>Allow Hov (High Occupancy vehicle) lanes while calculating an isoline.</p> <p>Default value: <code>false</code> </p>" } }, - "documentation":"<p>Features that are allowed while calculating. a route</p>" + "documentation":"<p>Features that are allowed while calculating an isoline.</p>" }, "IsolineAvoidanceArea":{ "type":"structure", @@ -702,7 +707,7 @@ "members":{ "Except":{ "shape":"IsolineAvoidanceAreaGeometryList", - "documentation":"<p>Exceptions to the provided avoidance geometry, to be included while calculating the route.</p>" + "documentation":"<p>Exceptions to the provided avoidance geometry, to be included while calculating an isoline.</p>" }, "Geometry":{ "shape":"IsolineAvoidanceAreaGeometry", @@ -735,7 +740,7 @@ "documentation":"<p>A list of PolylinePolygon's that are excluded for calculating isolines, the list can only contain 1 polygon. For more information on polyline encoding, see <a href=\"https://github.com/heremaps/flexiblepolyline/blob/master/README.md\">https://github.com/heremaps/flexiblepolyline/blob/master/README.md</a>. </p>" } }, - "documentation":"<p>The avoidance geometry, to be included while calculating the route.</p>" + "documentation":"<p>The avoidance geometry, to be included while calculating an isoline.</p>" }, "IsolineAvoidanceAreaGeometryList":{ "type":"list", @@ -766,23 +771,23 @@ }, "CarShuttleTrains":{ "shape":"Boolean", - "documentation":"<p>Avoid car-shuttle-trains while calculating the route.</p>" + "documentation":"<p>Avoid car-shuttle-trains while calculating an isoline.</p>" }, "ControlledAccessHighways":{ "shape":"Boolean", - "documentation":"<p>Avoid controlled access highways while calculating the route.</p>" + "documentation":"<p>Avoid controlled access highways while calculating an isoline.</p>" }, "DirtRoads":{ "shape":"Boolean", - "documentation":"<p>Avoid dirt roads while calculating the route.</p>" + "documentation":"<p>Avoid dirt roads while calculating an isoline.</p>" }, "Ferries":{ "shape":"Boolean", - "documentation":"<p>Avoid ferries while calculating the route.</p>" + "documentation":"<p>Avoid ferries while calculating an isoline.</p>" }, "SeasonalClosure":{ "shape":"Boolean", - "documentation":"<p>Avoid roads that have seasonal closure while calculating the route.</p>" + "documentation":"<p>Avoid roads that have seasonal closure while calculating an isoline.</p>" }, "TollRoads":{ "shape":"Boolean", @@ -798,7 +803,7 @@ }, "Tunnels":{ "shape":"Boolean", - "documentation":"<p>Avoid tunnels while calculating the route.</p>" + "documentation":"<p>Avoid tunnels while calculating an isoline.</p>" }, "UTurns":{ "shape":"Boolean", @@ -809,7 +814,7 @@ "documentation":"<p>Zone categories to be avoided.</p>" } }, - "documentation":"<p>Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.</p>" + "documentation":"<p>Features that are avoided while calculating isolines. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.</p>" }, "IsolineAvoidanceZoneCategory":{ "type":"structure", @@ -848,7 +853,7 @@ "documentation":"<p>The number of occupants in the vehicle.</p> <p>Default Value: <code>1</code> </p>" } }, - "documentation":"<p>Options for vehicles.</p>" + "documentation":"<p>Travel mode options when the provided travel mode is <code>Car</code>.</p>" }, "IsolineCarOptionsMaxSpeedDouble":{ "type":"double", @@ -900,7 +905,7 @@ "documentation":"<p>An ordered list of positions used to plot a route on a map in a lossy compression format.</p> <note> <p>LineString and Polyline are mutually exclusive properties.</p> </note>" } }, - "documentation":"<p>Geometry of the connection between different Isoline components.</p>" + "documentation":"<p>Geometry of the connection between different isoline components.</p>" }, "IsolineConnectionList":{ "type":"list", @@ -950,7 +955,7 @@ }, "MaxResolution":{ "shape":"DistanceMeters", - "documentation":"<p>Maximum resolution of the returned isoline.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>" + "documentation":"<p>Maximum resolution of the returned isoline.</p> <p> <b>Unit</b>: <code>meters</code> </p>" } }, "documentation":"<p>Isoline granularity related options.</p>" @@ -1038,7 +1043,7 @@ "documentation":"<p>Options to configure matching the provided position to a side of the street.</p>" } }, - "documentation":"<p>Options for the property.</p>" + "documentation":"<p>Origin related options.</p>" }, "IsolineScooterOptions":{ "type":"structure", @@ -1061,7 +1066,7 @@ "documentation":"<p>The number of occupants in the vehicle.</p> <p>Default Value: <code>1</code> </p>" } }, - "documentation":"<p>Options for the property.</p>" + "documentation":"<p>Travel mode options when the provided travel mode is <code>Scooter</code> </p>" }, "IsolineScooterOptionsMaxSpeedDouble":{ "type":"double", @@ -1118,7 +1123,7 @@ "documentation":"<p>Time to be used for the isoline calculation.</p>" } }, - "documentation":"<p>Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.</p>" + "documentation":"<p>Threshold to be used for the isoline calculation. Up to 5 thresholds per provided type can be requested.</p>" }, "IsolineTrafficOptions":{ "type":"structure", @@ -1177,7 +1182,7 @@ }, "Scooter":{ "shape":"IsolineScooterOptions", - "documentation":"<p>Travel mode options when the provided travel mode is \"Scooter\"</p>" + "documentation":"<p>Travel mode options when the provided travel mode is <code>Scooter</code> </p> <note> <p>When travel mode is set to <code>Scooter</code>, then the avoidance option <code>ControlledAccessHighways</code> defaults to <code>true</code>.</p> </note>" }, "Truck":{ "shape":"IsolineTruckOptions", @@ -1401,7 +1406,11 @@ "members":{ "Avoid":{ "shape":"WaypointOptimizationAvoidanceOptions", - "documentation":"<p>Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.</p>" + "documentation":"<p>Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.</p>" + }, + "Clustering":{ + "shape":"WaypointOptimizationClusteringOptions", + "documentation":"<p>Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.</p>" }, "DepartureTime":{ "shape":"TimestampWithTimezoneOffset", @@ -1804,14 +1813,14 @@ "members":{ "Hot":{ "shape":"Boolean", - "documentation":"<p>Allow Hot (High Occupancy Toll) lanes while calculating the route.</p>" + "documentation":"<p>Allow Hot (High Occupancy Toll) lanes while calculating the route.</p> <p>Default value: <code>false</code> </p>" }, "Hov":{ "shape":"Boolean", - "documentation":"<p>Allow Hov (High Occupancy vehicle) lanes while calculating the route.</p>" + "documentation":"<p>Allow Hov (High Occupancy vehicle) lanes while calculating the route.</p> <p>Default value: <code>false</code> </p>" } }, - "documentation":"<p>Features that are allowed while calculating. a route</p>" + "documentation":"<p>Features that are allowed while calculating a route.</p>" }, "RouteAvoidanceArea":{ "type":"structure", @@ -1923,7 +1932,7 @@ "documentation":"<p>Zone categories to be avoided.</p>" } }, - "documentation":"<p>Options related to areas to be avoided.</p>" + "documentation":"<p>Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.</p>" }, "RouteAvoidanceZoneCategory":{ "type":"structure", @@ -1963,7 +1972,7 @@ "documentation":"<p>The number of occupants in the vehicle.</p> <p>Default Value: <code>1</code> </p>" } }, - "documentation":"<p>Travel mode options when the provided travel mode is \"Car\"</p>" + "documentation":"<p>Travel mode options when the provided travel mode is <code>Car</code>.</p>" }, "RouteCarOptionsMaxSpeedDouble":{ "type":"double", @@ -2139,7 +2148,7 @@ "documentation":"<p>List of countries to be avoided defined by two-letter or three-letter country codes.</p>" } }, - "documentation":"<p>Exclusion options for the route.</p>" + "documentation":"<p>Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.</p>" }, "RouteExitStepDetails":{ "type":"structure", @@ -2342,7 +2351,8 @@ "NoSchedule", "Other", "ViolatedAvoidFerry", - "ViolatedAvoidRailFerry" + "ViolatedAvoidRailFerry", + "SeasonalClosure" ] }, "RouteFerryNoticeList":{ @@ -2404,7 +2414,7 @@ }, "Distance":{ "shape":"DistanceMeters", - "documentation":"<p>Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.</p>" + "documentation":"<p>Distance of the computed span. This feature doesn't split a span, but is always computed on a span split by other properties.</p> <p> <b>Unit</b>: <code>meters</code> </p>" }, "Duration":{ "shape":"DurationSeconds", @@ -2640,7 +2650,8 @@ "Ferry", "Pedestrian", "Scooter", - "Truck" + "Truck", + "CarShuttleTrain" ] }, "RouteLegType":{ @@ -2712,11 +2723,11 @@ "members":{ "Hot":{ "shape":"Boolean", - "documentation":"<p>Allow Hot (High Occupancy Toll) lanes while calculating the route.</p>" + "documentation":"<p>Allow Hot (High Occupancy Toll) lanes while calculating the route.</p> <p>Default value: <code>false</code> </p>" }, "Hov":{ "shape":"Boolean", - "documentation":"<p>Allow Hov (High Occupancy vehicle) lanes while calculating the route.</p>" + "documentation":"<p>Allow Hov (High Occupancy vehicle) lanes while calculating the route.</p> <p>Default value: <code>false</code> </p>" } }, "documentation":"<p>Allow Options related to the route matrix.</p>" @@ -2834,7 +2845,7 @@ "documentation":"<p>Zone categories to be avoided.</p>" } }, - "documentation":"<p>Options related to the route matrix.</p>" + "documentation":"<p>Specifies options for areas to avoid when calculating the route. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.</p>" }, "RouteMatrixAvoidanceOptionsAreasList":{ "type":"list", @@ -2917,7 +2928,7 @@ "documentation":"<p>The number of occupants in the vehicle.</p> <p>Default Value: <code>1</code> </p>" } }, - "documentation":"<p>Options related to the car.</p>" + "documentation":"<p>Travel mode options when the provided travel mode is <code>Car</code>.</p>" }, "RouteMatrixCarOptionsMaxSpeedDouble":{ "type":"double", @@ -3015,7 +3026,7 @@ "documentation":"<p>List of countries to be avoided defined by two-letter or three-letter country codes.</p>" } }, - "documentation":"<p>Exclusion options.</p>" + "documentation":"<p>Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.</p>" }, "RouteMatrixHazardousCargoType":{ "type":"string", @@ -3127,7 +3138,7 @@ "documentation":"<p>The number of occupants in the vehicle.</p> <p>Default Value: <code>1</code> </p>" } }, - "documentation":"<p>Travel mode options when the provided travel mode is \"Scooter\"</p>" + "documentation":"<p>Travel mode options when the provided travel mode is <code>Scooter</code> </p>" }, "RouteMatrixScooterOptionsMaxSpeedDouble":{ "type":"double", @@ -3202,7 +3213,7 @@ }, "Scooter":{ "shape":"RouteMatrixScooterOptions", - "documentation":"<p>Travel mode options when the provided travel mode is \"Scooter\"</p>" + "documentation":"<p>Travel mode options when the provided travel mode is <code>Scooter</code> </p> <note> <p>When travel mode is set to <code>Scooter</code>, then the avoidance option <code>ControlledAccessHighways</code> defaults to <code>true</code>.</p> </note>" }, "Truck":{ "shape":"RouteMatrixTruckOptions", @@ -4030,7 +4041,7 @@ "documentation":"<p>The number of occupants in the vehicle.</p> <p>Default Value: <code>1</code> </p>" } }, - "documentation":"<p>Travel mode options when the provided travel mode is \"Scooter\"</p>" + "documentation":"<p>Travel mode options when the provided travel mode is <code>Scooter</code> </p>" }, "RouteScooterOptionsMaxSpeedDouble":{ "type":"double", @@ -4702,7 +4713,7 @@ }, "Scooter":{ "shape":"RouteScooterOptions", - "documentation":"<p>Travel mode options when the provided travel mode is \"Scooter\"</p>" + "documentation":"<p>Travel mode options when the provided travel mode is <code>Scooter</code> </p> <note> <p>When travel mode is set to <code>Scooter</code>, then the avoidance option <code>ControlledAccessHighways</code> defaults to <code>true</code>.</p> </note>" }, "Truck":{ "shape":"RouteTruckOptions", @@ -5988,7 +5999,7 @@ "documentation":"<p>Avoid U-turns for calculation on highways and motorways.</p>" } }, - "documentation":"<p>Options for WaypointOptimizationAvoidance.</p>" + "documentation":"<p>Specifies options for areas to avoid. This is a best-effort avoidance setting, meaning the router will try to honor the avoidance preferences but may still include restricted areas if no feasible alternative route exists. If avoidance options are not followed, the response will indicate that the avoidance criteria were violated.</p>" }, "WaypointOptimizationAvoidanceOptionsAreasList":{ "type":"list", @@ -5996,6 +6007,28 @@ "max":20, "min":0 }, + "WaypointOptimizationClusteringAlgorithm":{ + "type":"string", + "enum":[ + "DrivingDistance", + "TopologySegment" + ] + }, + "WaypointOptimizationClusteringOptions":{ + "type":"structure", + "required":["Algorithm"], + "members":{ + "Algorithm":{ + "shape":"WaypointOptimizationClusteringAlgorithm", + "documentation":"<p>The algorithm to be used. <code>DrivingDistance</code> assigns all the waypoints that are within driving distance of each other into a single cluster. <code>TopologySegment</code> assigns all the waypoints that are within the same topology segment into a single cluster. A Topology segment is a linear stretch of road between two junctions.</p>" + }, + "DrivingDistanceOptions":{ + "shape":"WaypointOptimizationDrivingDistanceOptions", + "documentation":"<p>Driving distance options to be used when the clustering algorithm is DrivingDistance.</p>" + } + }, + "documentation":"<p>Options for WaypointOptimizationClustering.</p>" + }, "WaypointOptimizationConnection":{ "type":"structure", "required":[ @@ -6097,6 +6130,17 @@ }, "documentation":"<p>Driver related options.</p>" }, + "WaypointOptimizationDrivingDistanceOptions":{ + "type":"structure", + "required":["DrivingDistance"], + "members":{ + "DrivingDistance":{ + "shape":"DistanceMeters", + "documentation":"<p>DrivingDistance assigns all the waypoints that are within driving distance of each other into a single cluster.</p>" + } + }, + "documentation":"<p>Driving distance related options.</p>" + }, "WaypointOptimizationExclusionOptions":{ "type":"structure", "required":["Countries"], @@ -6106,7 +6150,7 @@ "documentation":"<p>List of countries to be avoided defined by two-letter or three-letter country codes.</p>" } }, - "documentation":"<p>Exclusion options.</p>" + "documentation":"<p>Specifies strict exclusion options for the route calculation. This setting mandates that the router will avoid any routes that include the specified options, rather than merely attempting to minimize them.</p>" }, "WaypointOptimizationFailedConstraint":{ "type":"structure", @@ -6185,6 +6229,10 @@ "shape":"TimestampWithTimezoneOffset", "documentation":"<p>Estimated time of arrival at the destination.</p> <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>" }, + "ClusterIndex":{ + "shape":"ClusterIndex", + "documentation":"<p>Index of the cluster the waypoint is associated with. The index is included in the response only if clustering was performed while processing the request.</p>" + }, "DepartureTime":{ "shape":"TimestampWithTimezoneOffset", "documentation":"<p>Estimated time of departure from thr origin.</p> <p>Time format:<code>YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm</code> </p> <p>Examples:</p> <p> <code>2020-04-22T17:57:24Z</code> </p> <p> <code>2020-04-22T17:57:24+02:00</code> </p>" @@ -6212,7 +6260,7 @@ "documentation":"<p>The Origin Id.</p>" } }, - "documentation":"<p>Options related to the origin.</p>" + "documentation":"<p>Origin related options.</p>" }, "WaypointOptimizationPedestrianOptions":{ "type":"structure", diff --git a/contrib/python/botocore/py3/botocore/data/glue/2017-03-31/service-2.json b/contrib/python/botocore/py3/botocore/data/glue/2017-03-31/service-2.json index eada834ebc4..1c3dbb89eca 100644 --- a/contrib/python/botocore/py3/botocore/data/glue/2017-03-31/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/glue/2017-03-31/service-2.json @@ -4342,7 +4342,7 @@ }, "Timeout":{ "shape":"Timeout", - "documentation":"<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.</p>" + "documentation":"<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This overrides the timeout value set in the parent job.</p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p> <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>" }, "SecurityConfiguration":{ "shape":"NameString", @@ -9156,7 +9156,7 @@ }, "Timeout":{ "shape":"Timeout", - "documentation":"<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours) for batch jobs.</p> <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>" + "documentation":"<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status.</p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p> <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>" }, "MaxCapacity":{ "shape":"NullableDouble", @@ -9588,7 +9588,7 @@ }, "Timeout":{ "shape":"Timeout", - "documentation":"<p> The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult the documentation for other job types. </p>" + "documentation":"<p> The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes). Consult the documentation for other job types. </p>" }, "IdleTimeout":{ "shape":"Timeout", @@ -17256,7 +17256,7 @@ }, "Timeout":{ "shape":"Timeout", - "documentation":"<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours) for batch jobs.</p> <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>" + "documentation":"<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status.</p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p> <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>" }, "MaxCapacity":{ "shape":"NullableDouble", @@ -17480,7 +17480,7 @@ }, "Timeout":{ "shape":"Timeout", - "documentation":"<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job.</p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>" + "documentation":"<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job.</p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p> <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>" }, "MaxCapacity":{ "shape":"NullableDouble", @@ -17607,7 +17607,7 @@ }, "Timeout":{ "shape":"Timeout", - "documentation":"<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours) for batch jobs.</p> <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>" + "documentation":"<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status.</p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p> <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>" }, "MaxCapacity":{ "shape":"NullableDouble", @@ -23718,7 +23718,7 @@ }, "Timeout":{ "shape":"Timeout", - "documentation":"<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job. </p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>" + "documentation":"<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job. </p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p> <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>" }, "MaxCapacity":{ "shape":"NullableDouble", diff --git a/contrib/python/botocore/py3/botocore/data/guardduty/2017-11-28/service-2.json b/contrib/python/botocore/py3/botocore/data/guardduty/2017-11-28/service-2.json index 315df5a419d..a9e9f525aca 100644 --- a/contrib/python/botocore/py3/botocore/data/guardduty/2017-11-28/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/guardduty/2017-11-28/service-2.json @@ -2420,7 +2420,7 @@ }, "FindingCriteria":{ "shape":"FindingCriteria", - "documentation":"<p>Represents the criteria to be used in the filter for querying findings.</p> <p>You can only use the following attributes to query findings:</p> <ul> <li> <p>accountId</p> </li> <li> <p>id</p> </li> <li> <p>region</p> </li> <li> <p>severity</p> <p>To filter on the basis of severity, the API and CLI use the following input list for the <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_FindingCriteria.html\">FindingCriteria</a> condition:</p> <ul> <li> <p> <b>Low</b>: <code>[\"1\", \"2\", \"3\"]</code> </p> </li> <li> <p> <b>Medium</b>: <code>[\"4\", \"5\", \"6\"]</code> </p> </li> <li> <p> <b>High</b>: <code>[\"7\", \"8\"]</code> </p> </li> <li> <p> <b>Critical</b>: <code>[\"9\", \"10\"]</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings-severity.html\">Findings severity levels</a> in the <i>Amazon GuardDuty User Guide</i>.</p> </li> <li> <p>type</p> </li> <li> <p>updatedAt</p> <p>Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds.</p> </li> <li> <p>resource.accessKeyDetails.accessKeyId</p> </li> <li> <p>resource.accessKeyDetails.principalId</p> </li> <li> <p>resource.accessKeyDetails.userName</p> </li> <li> <p>resource.accessKeyDetails.userType</p> </li> <li> <p>resource.instanceDetails.iamInstanceProfile.id</p> </li> <li> <p>resource.instanceDetails.imageId</p> </li> <li> <p>resource.instanceDetails.instanceId</p> </li> <li> <p>resource.instanceDetails.tags.key</p> </li> <li> <p>resource.instanceDetails.tags.value</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.ipv6Addresses</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicDnsName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicIp</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.subnetId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.vpcId</p> </li> <li> <p>resource.instanceDetails.outpostArn</p> </li> <li> <p>resource.resourceType</p> </li> <li> <p>resource.s3BucketDetails.publicAccess.effectivePermissions</p> </li> <li> <p>resource.s3BucketDetails.name</p> </li> <li> <p>resource.s3BucketDetails.tags.key</p> </li> <li> <p>resource.s3BucketDetails.tags.value</p> </li> <li> <p>resource.s3BucketDetails.type</p> </li> <li> <p>service.action.actionType</p> </li> <li> <p>service.action.awsApiCallAction.api</p> </li> <li> <p>service.action.awsApiCallAction.callerType</p> </li> <li> <p>service.action.awsApiCallAction.errorCode</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV6</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.awsApiCallAction.serviceName</p> </li> <li> <p>service.action.dnsRequestAction.domain</p> </li> <li> <p>service.action.dnsRequestAction.domainWithSuffix</p> </li> <li> <p>service.action.networkConnectionAction.blocked</p> </li> <li> <p>service.action.networkConnectionAction.connectionDirection</p> </li> <li> <p>service.action.networkConnectionAction.localPortDetails.port</p> </li> <li> <p>service.action.networkConnectionAction.protocol</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV6</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.networkConnectionAction.remotePortDetails.port</p> </li> <li> <p>service.action.awsApiCallAction.remoteAccountDetails.affiliated</p> </li> <li> <p>service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6</p> </li> <li> <p>service.action.kubernetesApiCallAction.namespace</p> </li> <li> <p>service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.kubernetesApiCallAction.requestUri</p> </li> <li> <p>service.action.kubernetesApiCallAction.statusCode</p> </li> <li> <p>service.action.networkConnectionAction.localIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.localIpDetails.ipAddressV6</p> </li> <li> <p>service.action.networkConnectionAction.protocol</p> </li> <li> <p>service.action.awsApiCallAction.serviceName</p> </li> <li> <p>service.action.awsApiCallAction.remoteAccountDetails.accountId</p> </li> <li> <p>service.additionalInfo.threatListName</p> </li> <li> <p>service.resourceRole</p> </li> <li> <p>resource.eksClusterDetails.name</p> </li> <li> <p>resource.kubernetesDetails.kubernetesWorkloadDetails.name</p> </li> <li> <p>resource.kubernetesDetails.kubernetesWorkloadDetails.namespace</p> </li> <li> <p>resource.kubernetesDetails.kubernetesUserDetails.username</p> </li> <li> <p>resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image</p> </li> <li> <p>resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix</p> </li> <li> <p>service.ebsVolumeScanDetails.scanId</p> </li> <li> <p>service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name</p> </li> <li> <p>service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity</p> </li> <li> <p>service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash</p> </li> <li> <p>resource.ecsClusterDetails.name</p> </li> <li> <p>resource.ecsClusterDetails.taskDetails.containers.image</p> </li> <li> <p>resource.ecsClusterDetails.taskDetails.definitionArn</p> </li> <li> <p>resource.containerDetails.image</p> </li> <li> <p>resource.rdsDbInstanceDetails.dbInstanceIdentifier</p> </li> <li> <p>resource.rdsDbInstanceDetails.dbClusterIdentifier</p> </li> <li> <p>resource.rdsDbInstanceDetails.engine</p> </li> <li> <p>resource.rdsDbUserDetails.user</p> </li> <li> <p>resource.rdsDbInstanceDetails.tags.key</p> </li> <li> <p>resource.rdsDbInstanceDetails.tags.value</p> </li> <li> <p>service.runtimeDetails.process.executableSha256</p> </li> <li> <p>service.runtimeDetails.process.name</p> </li> <li> <p>service.runtimeDetails.process.name</p> </li> <li> <p>resource.lambdaDetails.functionName</p> </li> <li> <p>resource.lambdaDetails.functionArn</p> </li> <li> <p>resource.lambdaDetails.tags.key</p> </li> <li> <p>resource.lambdaDetails.tags.value</p> </li> </ul>", + "documentation":"<p>Represents the criteria to be used in the filter for querying findings.</p> <p>You can only use the following attributes to query findings:</p> <ul> <li> <p>accountId</p> </li> <li> <p>id</p> </li> <li> <p>region</p> </li> <li> <p>severity</p> <p>To filter on the basis of severity, the API and CLI use the following input list for the <a href=\"https://docs.aws.amazon.com/guardduty/latest/APIReference/API_FindingCriteria.html\">FindingCriteria</a> condition:</p> <ul> <li> <p> <b>Low</b>: <code>[\"1\", \"2\", \"3\"]</code> </p> </li> <li> <p> <b>Medium</b>: <code>[\"4\", \"5\", \"6\"]</code> </p> </li> <li> <p> <b>High</b>: <code>[\"7\", \"8\"]</code> </p> </li> <li> <p> <b>Critical</b>: <code>[\"9\", \"10\"]</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings-severity.html\">Findings severity levels</a> in the <i>Amazon GuardDuty User Guide</i>.</p> </li> <li> <p>type</p> </li> <li> <p>updatedAt</p> <p>Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds.</p> </li> <li> <p>resource.accessKeyDetails.accessKeyId</p> </li> <li> <p>resource.accessKeyDetails.principalId</p> </li> <li> <p>resource.accessKeyDetails.userName</p> </li> <li> <p>resource.accessKeyDetails.userType</p> </li> <li> <p>resource.instanceDetails.iamInstanceProfile.id</p> </li> <li> <p>resource.instanceDetails.imageId</p> </li> <li> <p>resource.instanceDetails.instanceId</p> </li> <li> <p>resource.instanceDetails.tags.key</p> </li> <li> <p>resource.instanceDetails.tags.value</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.ipv6Addresses</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicDnsName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicIp</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.subnetId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.vpcId</p> </li> <li> <p>resource.instanceDetails.outpostArn</p> </li> <li> <p>resource.resourceType</p> </li> <li> <p>resource.s3BucketDetails.publicAccess.effectivePermissions</p> </li> <li> <p>resource.s3BucketDetails.name</p> </li> <li> <p>resource.s3BucketDetails.tags.key</p> </li> <li> <p>resource.s3BucketDetails.tags.value</p> </li> <li> <p>resource.s3BucketDetails.type</p> </li> <li> <p>service.action.actionType</p> </li> <li> <p>service.action.awsApiCallAction.api</p> </li> <li> <p>service.action.awsApiCallAction.callerType</p> </li> <li> <p>service.action.awsApiCallAction.errorCode</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV6</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.awsApiCallAction.serviceName</p> </li> <li> <p>service.action.dnsRequestAction.domain</p> </li> <li> <p>service.action.dnsRequestAction.domainWithSuffix</p> </li> <li> <p>service.action.networkConnectionAction.blocked</p> </li> <li> <p>service.action.networkConnectionAction.connectionDirection</p> </li> <li> <p>service.action.networkConnectionAction.localPortDetails.port</p> </li> <li> <p>service.action.networkConnectionAction.protocol</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV6</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.networkConnectionAction.remotePortDetails.port</p> </li> <li> <p>service.action.awsApiCallAction.remoteAccountDetails.affiliated</p> </li> <li> <p>service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV6</p> </li> <li> <p>service.action.kubernetesApiCallAction.namespace</p> </li> <li> <p>service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.kubernetesApiCallAction.requestUri</p> </li> <li> <p>service.action.kubernetesApiCallAction.statusCode</p> </li> <li> <p>service.action.networkConnectionAction.localIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.localIpDetails.ipAddressV6</p> </li> <li> <p>service.action.networkConnectionAction.protocol</p> </li> <li> <p>service.action.awsApiCallAction.serviceName</p> </li> <li> <p>service.action.awsApiCallAction.remoteAccountDetails.accountId</p> </li> <li> <p>service.additionalInfo.threatListName</p> </li> <li> <p>service.resourceRole</p> </li> <li> <p>resource.eksClusterDetails.name</p> </li> <li> <p>resource.kubernetesDetails.kubernetesWorkloadDetails.name</p> </li> <li> <p>resource.kubernetesDetails.kubernetesWorkloadDetails.namespace</p> </li> <li> <p>resource.kubernetesDetails.kubernetesUserDetails.username</p> </li> <li> <p>resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image</p> </li> <li> <p>resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix</p> </li> <li> <p>service.ebsVolumeScanDetails.scanId</p> </li> <li> <p>service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name</p> </li> <li> <p>service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity</p> </li> <li> <p>service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash</p> </li> <li> <p>resource.ecsClusterDetails.name</p> </li> <li> <p>resource.ecsClusterDetails.taskDetails.containers.image</p> </li> <li> <p>resource.ecsClusterDetails.taskDetails.definitionArn</p> </li> <li> <p>resource.containerDetails.image</p> </li> <li> <p>resource.rdsDbInstanceDetails.dbInstanceIdentifier</p> </li> <li> <p>resource.rdsDbInstanceDetails.dbClusterIdentifier</p> </li> <li> <p>resource.rdsDbInstanceDetails.engine</p> </li> <li> <p>resource.rdsDbUserDetails.user</p> </li> <li> <p>resource.rdsDbInstanceDetails.tags.key</p> </li> <li> <p>resource.rdsDbInstanceDetails.tags.value</p> </li> <li> <p>service.runtimeDetails.process.executableSha256</p> </li> <li> <p>service.runtimeDetails.process.name</p> </li> <li> <p>service.runtimeDetails.process.executablePath</p> </li> <li> <p>resource.lambdaDetails.functionName</p> </li> <li> <p>resource.lambdaDetails.functionArn</p> </li> <li> <p>resource.lambdaDetails.tags.key</p> </li> <li> <p>resource.lambdaDetails.tags.value</p> </li> </ul>", "locationName":"findingCriteria" }, "ClientToken":{ @@ -5225,12 +5225,12 @@ "members":{ "Key":{ "shape":"IndicatorType", - "documentation":"<p>Specific indicator keys observed in the attack sequence.</p>", + "documentation":"<p>Specific indicator keys observed in the attack sequence. For description of the valid values for key, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings-summary.html#guardduty-extended-threat-detection-attack-sequence-finding-details\">Attack sequence finding details</a> in the <i>Amazon GuardDuty User Guide</i>.</p>", "locationName":"key" }, "Values":{ "shape":"IndicatorValues", - "documentation":"<p>Values associated with each indicator key. For example, if the indicator key is <code>SUSPICIOUS_NETWORK</code>, then the value will be the name of the network. If the indicator key is <code>ATTACK_TACTIC</code>, then the value will be one of the MITRE tactics. </p> <p>For more information about the values associated with the key, see GuardDuty Extended Threat Detection in the <i>GuardDuty User Guide.</i> </p>", + "documentation":"<p>Values associated with each indicator key. For example, if the indicator key is <code>SUSPICIOUS_NETWORK</code>, then the value will be the name of the network. If the indicator key is <code>ATTACK_TACTIC</code>, then the value will be one of the MITRE tactics. </p>", "locationName":"values" }, "Title":{ @@ -6506,7 +6506,7 @@ }, "Message":{ "shape":"String", - "documentation":"<p>Issue message that specifies the reason. For information about potential troubleshooting steps, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/troubleshoot-s3-malware-protection-status-errors.html\">Troubleshooting Malware Protection for S3 status issues</a> in the <i>GuardDuty User Guide</i>.</p>", + "documentation":"<p>Issue message that specifies the reason. For information about potential troubleshooting steps, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/troubleshoot-s3-malware-protection-status-errors.html\">Troubleshooting Malware Protection for S3 status issues</a> in the <i>Amazon GuardDuty User Guide</i>.</p>", "locationName":"message" } }, @@ -9078,7 +9078,7 @@ }, "Type":{ "shape":"SignalType", - "documentation":"<p>The type of the signal used to identify an attack sequence.</p> <p>Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_data-sources.html\">Foundational data sources</a> in the <i>GuardDuty User Guide</i>.</p> <p>A signal type can be one of the valid values listed in this API. Here are the related descriptions:</p> <ul> <li> <p> <code>FINDING</code> - Individually generated GuardDuty finding.</p> </li> <li> <p> <code>CLOUD_TRAIL</code> - Activity observed from CloudTrail logs</p> </li> <li> <p> <code>S3_DATA_EVENTS</code> - Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/s3-protection.html\">S3 Protection</a> in the <i>GuardDuty User Guide</i>.</p> </li> </ul>", + "documentation":"<p>The type of the signal used to identify an attack sequence.</p> <p>Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_data-sources.html\">Foundational data sources</a> in the <i>Amazon GuardDuty User Guide</i>.</p> <p>A signal type can be one of the valid values listed in this API. Here are the related descriptions:</p> <ul> <li> <p> <code>FINDING</code> - Individually generated GuardDuty finding.</p> </li> <li> <p> <code>CLOUD_TRAIL</code> - Activity observed from CloudTrail logs</p> </li> <li> <p> <code>S3_DATA_EVENTS</code> - Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/s3-protection.html\">S3 Protection</a> in the <i>Amazon GuardDuty User Guide</i>.</p> </li> </ul>", "locationName":"type" }, "Description":{ @@ -9113,7 +9113,7 @@ }, "Severity":{ "shape":"Double", - "documentation":"<p>The severity associated with the signal. For more information about severity, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings-severity.html\">Findings severity levels</a> in the <i>GuardDuty User Guide</i>.</p>", + "documentation":"<p>The severity associated with the signal. For more information about severity, see <a href=\"https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings-severity.html\">Findings severity levels</a> in the <i>Amazon GuardDuty User Guide</i>.</p>", "locationName":"severity" }, "Count":{ @@ -9160,7 +9160,7 @@ "type":"list", "member":{"shape":"Signal"}, "max":100, - "min":2 + "min":1 }, "SortCriteria":{ "type":"structure", diff --git a/contrib/python/botocore/py3/botocore/data/healthlake/2017-07-01/service-2.json b/contrib/python/botocore/py3/botocore/data/healthlake/2017-07-01/service-2.json index 8980124fef5..7a719fa9182 100644 --- a/contrib/python/botocore/py3/botocore/data/healthlake/2017-07-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/healthlake/2017-07-01/service-2.json @@ -5,13 +5,15 @@ "endpointPrefix":"healthlake", "jsonVersion":"1.0", "protocol":"json", + "protocols":["json"], "serviceAbbreviation":"HealthLake", "serviceFullName":"Amazon HealthLake", "serviceId":"HealthLake", "signatureVersion":"v4", "signingName":"healthlake", "targetPrefix":"HealthLake", - "uid":"healthlake-2017-07-01" + "uid":"healthlake-2017-07-01", + "auth":["aws.auth#sigv4"] }, "operations":{ "CreateFHIRDatastore":{ @@ -241,6 +243,7 @@ "type":"string", "enum":[ "SMART_ON_FHIR_V1", + "SMART_ON_FHIR", "AWS_AUTH" ] }, @@ -807,6 +810,7 @@ "type":"string", "enum":[ "SUBMITTED", + "QUEUED", "IN_PROGRESS", "COMPLETED_WITH_ERRORS", "COMPLETED", @@ -1073,8 +1077,7 @@ "required":[ "OutputDataConfig", "DatastoreId", - "DataAccessRoleArn", - "ClientToken" + "DataAccessRoleArn" ], "members":{ "JobName":{ @@ -1127,8 +1130,7 @@ "InputDataConfig", "JobOutputDataConfig", "DatastoreId", - "DataAccessRoleArn", - "ClientToken" + "DataAccessRoleArn" ], "members":{ "JobName":{ diff --git a/contrib/python/botocore/py3/botocore/data/iam/2010-05-08/service-2.json b/contrib/python/botocore/py3/botocore/data/iam/2010-05-08/service-2.json index f7067122d2d..d207cca2521 100644 --- a/contrib/python/botocore/py3/botocore/data/iam/2010-05-08/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/iam/2010-05-08/service-2.json @@ -44,7 +44,7 @@ {"shape":"UnmodifiableEntityException"}, {"shape":"ServiceFailureException"} ], - "documentation":"<p>Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of <a href=\"https://en.wikipedia.org/wiki/Eventual_consistency\">eventual consistency</a>. To force the change, you must <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html\">disassociate the instance profile</a> and then <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html\">associate the instance profile</a>, or you can stop your instance and then restart it.</p> <note> <p>The caller of this operation must be granted the <code>PassRole</code> permission on the IAM role by a permissions policy.</p> </note> <p> For more information about roles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM roles</a> in the <i>IAM User Guide</i>. For more information about instance profiles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html\">Using instance profiles</a> in the <i>IAM User Guide</i>.</p>" + "documentation":"<p>Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this quota cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of Amazon Web Services because of <a href=\"https://en.wikipedia.org/wiki/Eventual_consistency\">eventual consistency</a>. To force the change, you must <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html\">disassociate the instance profile</a> and then <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html\">associate the instance profile</a>, or you can stop your instance and then restart it.</p> <note> <p>The caller of this operation must be granted the <code>PassRole</code> permission on the IAM role by a permissions policy.</p> </note> <important> <p>When using the <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_iam-condition-keys.html#available-keys-for-iam\">iam:AssociatedResourceArn</a> condition in a policy to restrict the <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html\">PassRole</a> IAM action, special considerations apply if the policy is intended to define access for the <code>AddRoleToInstanceProfile</code> action. In this case, you cannot specify a Region or instance ID in the EC2 instance ARN. The ARN value must be <code>arn:aws:ec2:*:CallerAccountId:instance/*</code>. Using any other ARN value may lead to unexpected evaluation results.</p> </important> <p> For more information about roles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM roles</a> in the <i>IAM User Guide</i>. For more information about instance profiles, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html\">Using instance profiles</a> in the <i>IAM User Guide</i>.</p>" }, "AddUserToGroup":{ "name":"AddUserToGroup", @@ -817,7 +817,7 @@ {"shape":"OrganizationNotFoundException"}, {"shape":"OrganizationNotInAllFeaturesModeException"} ], - "documentation":"<p>Disables the management of privileged root user credentials across member accounts in your organization. When you disable this feature, the management account and the delegated admininstrator for IAM can no longer manage root user credentials for member accounts in your organization.</p>" + "documentation":"<p>Disables the management of privileged root user credentials across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer manage root user credentials for member accounts in your organization.</p>" }, "DisableOrganizationsRootSessions":{ "name":"DisableOrganizationsRootSessions", @@ -836,7 +836,7 @@ {"shape":"OrganizationNotFoundException"}, {"shape":"OrganizationNotInAllFeaturesModeException"} ], - "documentation":"<p>Disables root user sessions for privileged tasks across member accounts in your organization. When you disable this feature, the management account and the delegated admininstrator for IAM can no longer perform privileged tasks on member accounts in your organization.</p>" + "documentation":"<p>Disables root user sessions for privileged tasks across member accounts in your organization. When you disable this feature, the management account and the delegated administrator for IAM can no longer perform privileged tasks on member accounts in your organization.</p>" }, "EnableMFADevice":{ "name":"EnableMFADevice", @@ -874,7 +874,7 @@ {"shape":"OrganizationNotInAllFeaturesModeException"}, {"shape":"CallerIsNotManagementAccountException"} ], - "documentation":"<p>Enables the management of privileged root user credentials across member accounts in your organization. When you enable root credentials management for <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#id_root-user-access-management\">centralized root access</a>, the management account and the delegated admininstrator for IAM can manage root user credentials for member accounts in your organization.</p> <p>Before you enable centralized root access, you must have an account configured with the following settings:</p> <ul> <li> <p>You must manage your Amazon Web Services accounts in <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html\">Organizations</a>.</p> </li> <li> <p>Enable trusted access for Identity and Access Management in Organizations. For details, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/services-that-can-integrate-ra.html\">IAM and Organizations</a> in the <i>Organizations User Guide</i>.</p> </li> </ul>" + "documentation":"<p>Enables the management of privileged root user credentials across member accounts in your organization. When you enable root credentials management for <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#id_root-user-access-management\">centralized root access</a>, the management account and the delegated administrator for IAM can manage root user credentials for member accounts in your organization.</p> <p>Before you enable centralized root access, you must have an account configured with the following settings:</p> <ul> <li> <p>You must manage your Amazon Web Services accounts in <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html\">Organizations</a>.</p> </li> <li> <p>Enable trusted access for Identity and Access Management in Organizations. For details, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/services-that-can-integrate-iam.html\">IAM and Organizations</a> in the <i>Organizations User Guide</i>.</p> </li> </ul>" }, "EnableOrganizationsRootSessions":{ "name":"EnableOrganizationsRootSessions", @@ -1414,7 +1414,7 @@ "errors":[ {"shape":"ServiceFailureException"} ], - "documentation":"<p>Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see <a href=\"https://docs.aws.amazon.com/signin/latest/userguide/CreateAccountAlias.html\">Creating, deleting, and listing an Amazon Web Services account alias</a> in the <i>Amazon Web Services Sign-In User Guide</i>.</p>" + "documentation":"<p>Lists the account alias associated with the Amazon Web Services account (Note: you can have only one). For information about using an Amazon Web Services account alias, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html#CreateAccountAlias\">Creating, deleting, and listing an Amazon Web Services account alias</a> in the <i>IAM User Guide</i>.</p>" }, "ListAttachedGroupPolicies":{ "name":"ListAttachedGroupPolicies", @@ -2578,7 +2578,7 @@ {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], - "documentation":"<p>Updates the metadata document for an existing SAML provider resource object.</p> <note> <p>This operation requires <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>.</p> </note>" + "documentation":"<p>Updates the metadata document, SAML encryption settings, and private keys for an existing SAML provider. To rotate private keys, add your new private key and then remove the old key in a separate request.</p>" }, "UpdateSSHPublicKey":{ "name":"UpdateSSHPublicKey", @@ -3382,6 +3382,14 @@ "Tags":{ "shape":"tagListType", "documentation":"<p>A list of tags that you want to attach to the new IAM SAML provider. Each tag consists of a key name and an associated value. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html\">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p> <note> <p>If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.</p> </note>" + }, + "AssertionEncryptionMode":{ + "shape":"assertionEncryptionModeType", + "documentation":"<p>Specifies the encryption setting for the SAML provider.</p>" + }, + "AddPrivateKey":{ + "shape":"privateKeyType", + "documentation":"<p>The private key generated from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.</p>" } } }, @@ -4814,6 +4822,10 @@ "GetSAMLProviderResponse":{ "type":"structure", "members":{ + "SAMLProviderUUID":{ + "shape":"privateKeyIdType", + "documentation":"<p>The unique identifier assigned to the SAML provider.</p>" + }, "SAMLMetadataDocument":{ "shape":"SAMLMetadataDocumentType", "documentation":"<p>The XML metadata document that includes information about an identity provider.</p>" @@ -4829,6 +4841,14 @@ "Tags":{ "shape":"tagListType", "documentation":"<p>A list of tags that are attached to the specified IAM SAML provider. The returned list of tags is sorted by tag key. For more information about tagging, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html\">Tagging IAM resources</a> in the <i>IAM User Guide</i>.</p>" + }, + "AssertionEncryptionMode":{ + "shape":"assertionEncryptionModeType", + "documentation":"<p>Specifies the encryption setting for the SAML provider.</p>" + }, + "PrivateKeyList":{ + "shape":"privateKeyList", + "documentation":"<p>The private key metadata for the SAML provider.</p>" } }, "documentation":"<p>Contains the response to a successful <a>GetSAMLProvider</a> request. </p>" @@ -7481,6 +7501,20 @@ "max":10000000, "min":1000 }, + "SAMLPrivateKey":{ + "type":"structure", + "members":{ + "KeyId":{ + "shape":"privateKeyIdType", + "documentation":"<p>The unique identifier for the SAML private key.</p>" + }, + "Timestamp":{ + "shape":"dateType", + "documentation":"<p>The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time </a> format, when the private key was uploaded.</p>" + } + }, + "documentation":"<p>Contains the private keys for the SAML provider.</p> <p>This data type is used as a response element in the <a>GetSAMLProvider</a> operation.</p>" + }, "SAMLProviderListEntry":{ "type":"structure", "members":{ @@ -8538,18 +8572,27 @@ }, "UpdateSAMLProviderRequest":{ "type":"structure", - "required":[ - "SAMLMetadataDocument", - "SAMLProviderArn" - ], + "required":["SAMLProviderArn"], "members":{ "SAMLMetadataDocument":{ "shape":"SAMLMetadataDocumentType", - "documentation":"<p>An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.</p>" + "documentation":"<p>An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.</p>" }, "SAMLProviderArn":{ "shape":"arnType", "documentation":"<p>The Amazon Resource Name (ARN) of the SAML provider to update.</p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>" + }, + "AssertionEncryptionMode":{ + "shape":"assertionEncryptionModeType", + "documentation":"<p>Specifies the encryption setting for the SAML provider.</p>" + }, + "AddPrivateKey":{ + "shape":"privateKeyType", + "documentation":"<p>Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.</p>" + }, + "RemovePrivateKey":{ + "shape":"privateKeyIdType", + "documentation":"<p>The Key ID of the private key to remove.</p>" } } }, @@ -8913,6 +8956,13 @@ "max":2048, "min":20 }, + "assertionEncryptionModeType":{ + "type":"string", + "enum":[ + "Required", + "Allowed" + ] + }, "assignmentStatusType":{ "type":"string", "enum":[ @@ -9218,6 +9268,17 @@ "type":"string", "pattern":"v[1-9][0-9]*(\\.[A-Za-z0-9-]*)?" }, + "privateKeyIdType":{ + "type":"string", + "max":64, + "min":22, + "pattern":"[A-Z0-9]+" + }, + "privateKeyList":{ + "type":"list", + "member":{"shape":"SAMLPrivateKey"}, + "max":2 + }, "privateKeyType":{ "type":"string", "max":16384, diff --git a/contrib/python/botocore/py3/botocore/data/iot/2015-05-28/service-2.json b/contrib/python/botocore/py3/botocore/data/iot/2015-05-28/service-2.json index 4162a60d22b..1d237434e87 100644 --- a/contrib/python/botocore/py3/botocore/data/iot/2015-05-28/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/iot/2015-05-28/service-2.json @@ -17582,7 +17582,7 @@ }, "ParameterValue":{ "type":"string", - "max":512, + "max":30720, "min":1, "pattern":"[^\\p{C}]+" }, diff --git a/contrib/python/botocore/py3/botocore/data/iotsitewise/2019-12-02/service-2.json b/contrib/python/botocore/py3/botocore/data/iotsitewise/2019-12-02/service-2.json index 721158573ea..2d97cd3c17d 100644 --- a/contrib/python/botocore/py3/botocore/data/iotsitewise/2019-12-02/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/iotsitewise/2019-12-02/service-2.json @@ -3583,6 +3583,10 @@ "type":"structure", "required":["entries"], "members":{ + "enablePartialEntryProcessing":{ + "shape":"BooleanValue", + "documentation":"<p>This setting enables partial ingestion at entry-level. If set to <code>true</code>, we ingest all TQVs not resulting in an error. If set to <code>false</code>, an invalid TQV fails ingestion of the entire entry that contains it.</p>" + }, "entries":{ "shape":"PutAssetPropertyValueEntries", "documentation":"<p>The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.</p>" @@ -3599,6 +3603,7 @@ } } }, + "BooleanValue":{"type":"boolean"}, "Bucket":{ "type":"string", "max":63, @@ -6023,6 +6028,10 @@ "warmTierRetentionPeriod":{ "shape":"WarmTierRetentionPeriod", "documentation":"<p>Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.</p>" + }, + "disallowIngestNullNaN":{ + "shape":"DisallowIngestNullNaN", + "documentation":"<p>Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is <code>true</code>.</p>" } } }, @@ -6133,6 +6142,7 @@ "type":"list", "member":{"shape":"DetailedError"} }, + "DisallowIngestNullNaN":{"type":"boolean"}, "DisassociateAssetsRequest":{ "type":"structure", "required":[ @@ -8206,10 +8216,7 @@ "type":"boolean", "box":true }, - "NumberOfDays":{ - "type":"integer", - "min":30 - }, + "NumberOfDays":{"type":"integer"}, "Offset":{ "type":"string", "max":25, @@ -8543,6 +8550,17 @@ "PropertyValueBooleanValue":{"type":"boolean"}, "PropertyValueDoubleValue":{"type":"double"}, "PropertyValueIntegerValue":{"type":"integer"}, + "PropertyValueNullValue":{ + "type":"structure", + "required":["valueType"], + "members":{ + "valueType":{ + "shape":"RawValueType", + "documentation":"<p>The type of null asset property data.</p>" + } + }, + "documentation":"<p>The value type of null asset property data with BAD and UNCERTAIN qualities.</p>" + }, "PropertyValueStringValue":{"type":"string"}, "PutAssetPropertyValueEntries":{ "type":"list", @@ -8652,6 +8670,10 @@ "warmTierRetentionPeriod":{ "shape":"WarmTierRetentionPeriod", "documentation":"<p>Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.</p>" + }, + "disallowIngestNullNaN":{ + "shape":"DisallowIngestNullNaN", + "documentation":"<p>Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is <code>true</code>.</p>" } } }, @@ -8683,6 +8705,10 @@ "warmTierRetentionPeriod":{ "shape":"WarmTierRetentionPeriod", "documentation":"<p>Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.</p>" + }, + "disallowIngestNullNaN":{ + "shape":"DisallowIngestNullNaN", + "documentation":"<p>Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is <code>true</code>.</p>" } } }, @@ -8714,6 +8740,16 @@ "error":{"httpStatusCode":400}, "exception":true }, + "RawValueType":{ + "type":"string", + "enum":[ + "D", + "B", + "S", + "I", + "U" + ] + }, "Reference":{ "type":"structure", "members":{ @@ -9773,7 +9809,7 @@ "members":{ "stringValue":{ "shape":"PropertyValueStringValue", - "documentation":"<p>Asset property data of type string (sequence of characters).</p>" + "documentation":"<p> Asset property data of type string (sequence of characters). The allowed pattern: \"^$|[^\\u0000-\\u001F\\u007F]+\". The max length is 1024. </p>" }, "integerValue":{ "shape":"PropertyValueIntegerValue", @@ -9781,11 +9817,15 @@ }, "doubleValue":{ "shape":"PropertyValueDoubleValue", - "documentation":"<p>Asset property data of type double (floating point number).</p>" + "documentation":"<p> Asset property data of type double (floating point number). The min value is -10^10. The max value is 10^10. Double.NaN is allowed. </p>" }, "booleanValue":{ "shape":"PropertyValueBooleanValue", "documentation":"<p>Asset property data of type Boolean (true or false).</p>" + }, + "nullValue":{ + "shape":"PropertyValueNullValue", + "documentation":"<p>The type of null asset property data with BAD and UNCERTAIN qualities.</p>" } }, "documentation":"<p>Contains an asset property value (of a single type only).</p>" diff --git a/contrib/python/botocore/py3/botocore/data/license-manager-user-subscriptions/2018-05-10/service-2.json b/contrib/python/botocore/py3/botocore/data/license-manager-user-subscriptions/2018-05-10/service-2.json index 985e3b81420..a48f82358ce 100644 --- a/contrib/python/botocore/py3/botocore/data/license-manager-user-subscriptions/2018-05-10/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/license-manager-user-subscriptions/2018-05-10/service-2.json @@ -550,7 +550,7 @@ }, "Product":{ "shape":"String", - "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> </p>" + "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> | <code>REMOTE_DESKTOP_SERVICES</code> </p>" } } }, @@ -1018,7 +1018,7 @@ }, "Product":{ "shape":"String", - "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> </p>" + "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> | <code>REMOTE_DESKTOP_SERVICES</code> </p>" } } }, @@ -1174,7 +1174,7 @@ }, "Product":{ "shape":"String", - "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> </p>" + "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> | <code>REMOTE_DESKTOP_SERVICES</code> </p>" }, "Settings":{ "shape":"Settings", @@ -1306,7 +1306,7 @@ }, "Product":{ "shape":"String", - "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> </p>" + "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> | <code>REMOTE_DESKTOP_SERVICES</code> </p>" }, "Tags":{ "shape":"Tags", @@ -1341,7 +1341,7 @@ }, "Product":{ "shape":"String", - "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> </p>" + "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> | <code>REMOTE_DESKTOP_SERVICES</code> </p>" }, "ProductUserArn":{ "shape":"Arn", @@ -1461,7 +1461,7 @@ }, "Product":{ "shape":"String", - "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> </p>" + "documentation":"<p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> | <code>REMOTE_DESKTOP_SERVICES</code> </p>" }, "UpdateSettings":{ "shape":"UpdateSettings", diff --git a/contrib/python/botocore/py3/botocore/data/lightsail/2016-11-28/service-2.json b/contrib/python/botocore/py3/botocore/data/lightsail/2016-11-28/service-2.json index 665fb211e03..fa80fe96e10 100644 --- a/contrib/python/botocore/py3/botocore/data/lightsail/2016-11-28/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/lightsail/2016-11-28/service-2.json @@ -68,7 +68,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.</p> <p>The <code>attach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.</p> <p>The <code>attach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "AttachInstancesToLoadBalancer":{ "name":"AttachInstancesToLoadBalancer", @@ -87,7 +87,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Attaches one or more Lightsail instances to a load balancer.</p> <p>After some time, the instances are attached to the load balancer and the health check status is available.</p> <p>The <code>attach instances to load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Attaches one or more Lightsail instances to a load balancer.</p> <p>After some time, the instances are attached to the load balancer and the health check status is available.</p> <p>The <code>attach instances to load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Lightsail Developer Guide</a>.</p>" }, "AttachLoadBalancerTlsCertificate":{ "name":"AttachLoadBalancerTlsCertificate", @@ -106,7 +106,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the <code>AttachLoadBalancerTlsCertificate</code> action with the non-attached certificate, and it will replace the existing one and become the attached certificate.</p> <p>The <code>AttachLoadBalancerTlsCertificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the <code>AttachLoadBalancerTlsCertificate</code> action with the non-attached certificate, and it will replace the existing one and become the attached certificate.</p> <p>The <code>AttachLoadBalancerTlsCertificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "AttachStaticIp":{ "name":"AttachStaticIp", @@ -144,7 +144,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Closes ports for a specific Amazon Lightsail instance.</p> <p>The <code>CloseInstancePublicPorts</code> action supports tag-based access control via resource tags applied to the resource identified by <code>instanceName</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Closes ports for a specific Amazon Lightsail instance.</p> <p>The <code>CloseInstancePublicPorts</code> action supports tag-based access control via resource tags applied to the resource identified by <code>instanceName</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CopySnapshot":{ "name":"CopySnapshot", @@ -179,7 +179,7 @@ {"shape":"ServiceException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates an Amazon Lightsail bucket.</p> <p>A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail\">Buckets in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Creates an Amazon Lightsail bucket.</p> <p>A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/buckets-in-amazon-lightsail\">Buckets in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "CreateBucketAccessKey":{ "name":"CreateBucketAccessKey", @@ -196,7 +196,7 @@ {"shape":"ServiceException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.</p> <p>Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html\">GetBucketAccessKeys</a> action to get a list of current access keys for a specific bucket. For more information about access keys, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> <important> <p>The <code>secretAccessKey</code> value is returned only in response to the <code>CreateBucketAccessKey</code> action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.</p> </important>" + "documentation":"<p>Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.</p> <p>Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html\">GetBucketAccessKeys</a> action to get a list of current access keys for a specific bucket. For more information about access keys, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> <important> <p>The <code>secretAccessKey</code> value is returned only in response to the <code>CreateBucketAccessKey</code> action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.</p> </important>" }, "CreateCertificate":{ "name":"CreateCertificate", @@ -250,7 +250,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates an email or SMS text message contact method.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>" + "documentation":"<p>Creates an email or SMS text message contact method.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>" }, "CreateContainerService":{ "name":"CreateContainerService", @@ -267,7 +267,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates an Amazon Lightsail container service.</p> <p>A Lightsail container service is a compute resource to which you can deploy containers. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-services\">Container services in Amazon Lightsail</a> in the <i>Lightsail Dev Guide</i>.</p>" + "documentation":"<p>Creates an Amazon Lightsail container service.</p> <p>A Lightsail container service is a compute resource to which you can deploy containers. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-services\">Container services in Amazon Lightsail</a> in the <i>Lightsail Dev Guide</i>.</p>" }, "CreateContainerServiceDeployment":{ "name":"CreateContainerServiceDeployment", @@ -284,7 +284,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a deployment for your Amazon Lightsail container service.</p> <p>A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.</p> <p>You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images\">Creating container images for your Amazon Lightsail container services</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Creates a deployment for your Amazon Lightsail container service.</p> <p>A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.</p> <p>You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-creating-container-images\">Creating container images for your Amazon Lightsail container services</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "CreateContainerServiceRegistryLogin":{ "name":"CreateContainerServiceRegistryLogin", @@ -301,7 +301,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.</p> <note> <p>You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.</p> </note> <p>After you push your container images to the container image registry of your Lightsail account, use the <code>RegisterContainerImage</code> action to register the pushed images to a specific Lightsail container service.</p> <note> <p>This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images\">Pushing and managing container images on your Amazon Lightsail container services</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> </note>" + "documentation":"<p>Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.</p> <note> <p>You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.</p> </note> <p>After you push your container images to the container image registry of your Lightsail account, use the <code>RegisterContainerImage</code> action to register the pushed images to a specific Lightsail container service.</p> <note> <p>This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-pushing-container-images\">Pushing and managing container images on your Amazon Lightsail container services</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> </note>" }, "CreateDisk":{ "name":"CreateDisk", @@ -320,7 +320,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (<code>us-east-2a</code>).</p> <p>The <code>create disk</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (<code>us-east-2a</code>).</p> <p>The <code>create disk</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateDiskFromSnapshot":{ "name":"CreateDiskFromSnapshot", @@ -339,7 +339,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (<code>us-east-2a</code>).</p> <p>The <code>create disk from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>disk snapshot name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (<code>us-east-2a</code>).</p> <p>The <code>create disk from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>disk snapshot name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateDiskSnapshot":{ "name":"CreateDiskSnapshot", @@ -358,7 +358,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.</p> <p>You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.</p> <p>You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the <code>instance name</code> parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.</p> <p>The <code>create disk snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.</p> <p>You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.</p> <p>You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the <code>instance name</code> parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.</p> <p>The <code>create disk snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateDistribution":{ "name":"CreateDistribution", @@ -376,7 +376,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates an Amazon Lightsail content delivery network (CDN) distribution.</p> <p>A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-content-delivery-network-distributions\">Content delivery networks in Amazon Lightsail</a>.</p>" + "documentation":"<p>Creates an Amazon Lightsail content delivery network (CDN) distribution.</p> <p>A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-content-delivery-network-distributions\">Content delivery networks in Amazon Lightsail</a>.</p>" }, "CreateDomain":{ "name":"CreateDomain", @@ -395,7 +395,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a domain resource for the specified domain (example.com).</p> <p>The <code>create domain</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates a domain resource for the specified domain (example.com).</p> <p>The <code>create domain</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateDomainEntry":{ "name":"CreateDomainEntry", @@ -414,7 +414,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).</p> <p>The <code>create domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).</p> <p>The <code>create domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateGUISessionAccessDetails":{ "name":"CreateGUISessionAccessDetails", @@ -431,7 +431,7 @@ {"shape":"ServiceException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session. </p> <p>Use <code>StartGUISession</code> to open the session.</p>" + "documentation":"<p>Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The secondary URL initiates a web-based Amazon DCV session to the virtual computer's operating session. </p> <p>Use <code>StartGUISession</code> to open the session.</p>" }, "CreateInstanceSnapshot":{ "name":"CreateInstanceSnapshot", @@ -450,7 +450,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a snapshot of a specific virtual private server, or <i>instance</i>. You can use a snapshot to create a new instance that is based on that snapshot.</p> <p>The <code>create instance snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates a snapshot of a specific virtual private server, or <i>instance</i>. You can use a snapshot to create a new instance that is based on that snapshot.</p> <p>The <code>create instance snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateInstances":{ "name":"CreateInstances", @@ -469,7 +469,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates one or more Amazon Lightsail instances.</p> <p>The <code>create instances</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates one or more Amazon Lightsail instances.</p> <p>The <code>create instances</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Lightsail Developer Guide</a>.</p>" }, "CreateInstancesFromSnapshot":{ "name":"CreateInstancesFromSnapshot", @@ -488,7 +488,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates one or more new instances from a manual or automatic snapshot of an instance.</p> <p>The <code>create instances from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>instance snapshot name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates one or more new instances from a manual or automatic snapshot of an instance.</p> <p>The <code>create instances from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>instance snapshot name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateKeyPair":{ "name":"CreateKeyPair", @@ -507,7 +507,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.</p> <note> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html\">DownloadDefaultKeyPair</a> action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.</p> </note> <p>The <code>create key pair</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.</p> <note> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html\">DownloadDefaultKeyPair</a> action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.</p> </note> <p>The <code>create key pair</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateLoadBalancer":{ "name":"CreateLoadBalancer", @@ -526,7 +526,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/configure-lightsail-instances-for-load-balancing\">Configure your Lightsail instances for load balancing</a>. You can create up to 5 load balancers per AWS Region in your account.</p> <p>When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the <code>UpdateLoadBalancerAttribute</code> operation.</p> <p>The <code>create load balancer</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/configure-lightsail-instances-for-load-balancing\">Configure your Lightsail instances for load balancing</a>. You can create up to 5 load balancers per AWS Region in your account.</p> <p>When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the <code>UpdateLoadBalancerAttribute</code> operation.</p> <p>The <code>create load balancer</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateLoadBalancerTlsCertificate":{ "name":"CreateLoadBalancerTlsCertificate", @@ -545,7 +545,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>The <code>CreateLoadBalancerTlsCertificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>The <code>CreateLoadBalancerTlsCertificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateRelationalDatabase":{ "name":"CreateRelationalDatabase", @@ -564,7 +564,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a new database in Amazon Lightsail.</p> <p>The <code>create relational database</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates a new database in Amazon Lightsail.</p> <p>The <code>create relational database</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateRelationalDatabaseFromSnapshot":{ "name":"CreateRelationalDatabaseFromSnapshot", @@ -583,7 +583,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a new database from an existing database snapshot in Amazon Lightsail.</p> <p>You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.</p> <p>The <code>create relational database from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates a new database from an existing database snapshot in Amazon Lightsail.</p> <p>You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.</p> <p>The <code>create relational database from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "CreateRelationalDatabaseSnapshot":{ "name":"CreateRelationalDatabaseSnapshot", @@ -602,7 +602,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.</p> <p>The <code>create relational database snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.</p> <p>The <code>create relational database snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteAlarm":{ "name":"DeleteAlarm", @@ -620,7 +620,7 @@ {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"} ], - "documentation":"<p>Deletes an alarm.</p> <p>An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p>" + "documentation":"<p>Deletes an alarm.</p> <p>An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p>" }, "DeleteAutoSnapshot":{ "name":"DeleteAutoSnapshot", @@ -638,7 +638,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes an automatic snapshot of an instance or disk. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes an automatic snapshot of an instance or disk. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteBucket":{ "name":"DeleteBucket", @@ -672,7 +672,7 @@ {"shape":"ServiceException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes an access key for the specified Amazon Lightsail bucket.</p> <p>We recommend that you delete an access key if the secret access key is compromised.</p> <p>For more information about access keys, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Deletes an access key for the specified Amazon Lightsail bucket.</p> <p>We recommend that you delete an access key if the secret access key is compromised.</p> <p>For more information about access keys, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "DeleteCertificate":{ "name":"DeleteCertificate", @@ -707,7 +707,7 @@ {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"} ], - "documentation":"<p>Deletes a contact method.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>" + "documentation":"<p>Deletes a contact method.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>" }, "DeleteContainerImage":{ "name":"DeleteContainerImage", @@ -760,7 +760,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes the specified block storage disk. The disk must be in the <code>available</code> state (not attached to a Lightsail instance).</p> <note> <p>The disk may remain in the <code>deleting</code> state for several minutes.</p> </note> <p>The <code>delete disk</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes the specified block storage disk. The disk must be in the <code>available</code> state (not attached to a Lightsail instance).</p> <note> <p>The disk may remain in the <code>deleting</code> state for several minutes.</p> </note> <p>The <code>delete disk</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteDiskSnapshot":{ "name":"DeleteDiskSnapshot", @@ -779,7 +779,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes the specified disk snapshot.</p> <p>When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.</p> <p>The <code>delete disk snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk snapshot name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes the specified disk snapshot.</p> <p>When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.</p> <p>The <code>delete disk snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk snapshot name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteDistribution":{ "name":"DeleteDistribution", @@ -816,7 +816,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes the specified domain recordset and all of its domain records.</p> <p>The <code>delete domain</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes the specified domain recordset and all of its domain records.</p> <p>The <code>delete domain</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteDomainEntry":{ "name":"DeleteDomainEntry", @@ -835,7 +835,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes a specific domain entry.</p> <p>The <code>delete domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes a specific domain entry.</p> <p>The <code>delete domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteInstance":{ "name":"DeleteInstance", @@ -854,7 +854,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes an Amazon Lightsail instance.</p> <p>The <code>delete instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes an Amazon Lightsail instance.</p> <p>The <code>delete instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteInstanceSnapshot":{ "name":"DeleteInstanceSnapshot", @@ -873,7 +873,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes a specific snapshot of a virtual private server (or <i>instance</i>).</p> <p>The <code>delete instance snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance snapshot name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes a specific snapshot of a virtual private server (or <i>instance</i>).</p> <p>The <code>delete instance snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance snapshot name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteKeyPair":{ "name":"DeleteKeyPair", @@ -892,7 +892,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes the specified key pair by removing the public key from Amazon Lightsail.</p> <p>You can delete key pairs that were created using the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html\">ImportKeyPair</a> and <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html\">CreateKeyPair</a> actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html\">DownloadDefaultKeyPair</a> API. </p> <p>The <code>delete key pair</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>key pair name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes the specified key pair by removing the public key from Amazon Lightsail.</p> <p>You can delete key pairs that were created using the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html\">ImportKeyPair</a> and <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html\">CreateKeyPair</a> actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html\">DownloadDefaultKeyPair</a> API. </p> <p>The <code>delete key pair</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>key pair name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteKnownHostKeys":{ "name":"DeleteKnownHostKeys", @@ -911,7 +911,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.</p> <important> <p>Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection\">Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client</a>.</p> </important>" + "documentation":"<p>Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.</p> <important> <p>Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection\">Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client</a>.</p> </important>" }, "DeleteLoadBalancer":{ "name":"DeleteLoadBalancer", @@ -930,7 +930,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.</p> <p>The <code>delete load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.</p> <p>The <code>delete load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteLoadBalancerTlsCertificate":{ "name":"DeleteLoadBalancerTlsCertificate", @@ -949,7 +949,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes an SSL/TLS certificate associated with a Lightsail load balancer.</p> <p>The <code>DeleteLoadBalancerTlsCertificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes an SSL/TLS certificate associated with a Lightsail load balancer.</p> <p>The <code>DeleteLoadBalancerTlsCertificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteRelationalDatabase":{ "name":"DeleteRelationalDatabase", @@ -968,7 +968,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes a database in Amazon Lightsail.</p> <p>The <code>delete relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes a database in Amazon Lightsail.</p> <p>The <code>delete relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DeleteRelationalDatabaseSnapshot":{ "name":"DeleteRelationalDatabaseSnapshot", @@ -987,7 +987,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes a database snapshot in Amazon Lightsail.</p> <p>The <code>delete relational database snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes a database snapshot in Amazon Lightsail.</p> <p>The <code>delete relational database snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DetachCertificateFromDistribution":{ "name":"DetachCertificateFromDistribution", @@ -1024,7 +1024,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.</p> <p>The <code>detach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.</p> <p>The <code>detach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DetachInstancesFromLoadBalancer":{ "name":"DetachInstancesFromLoadBalancer", @@ -1043,7 +1043,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Detaches the specified instances from a Lightsail load balancer.</p> <p>This operation waits until the instances are no longer needed before they are detached from the load balancer.</p> <p>The <code>detach instances from load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Detaches the specified instances from a Lightsail load balancer.</p> <p>This operation waits until the instances are no longer needed before they are detached from the load balancer.</p> <p>The <code>detach instances from load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "DetachStaticIp":{ "name":"DetachStaticIp", @@ -1080,7 +1080,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Disables an add-on for an Amazon Lightsail resource. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Disables an add-on for an Amazon Lightsail resource. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p>" }, "DownloadDefaultKeyPair":{ "name":"DownloadDefaultKeyPair", @@ -1117,7 +1117,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p>" }, "ExportSnapshot":{ "name":"ExportSnapshot", @@ -1136,7 +1136,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the <code>create cloud formation stack</code> operation to create new Amazon EC2 instances.</p> <p>Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.</p> <p/> <p>The <code>export snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>source snapshot name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p> <note> <p>Use the <code>get instance snapshots</code> or <code>get disk snapshots</code> operations to get a list of snapshots that you can export to Amazon EC2.</p> </note>" + "documentation":"<p>Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the <code>create cloud formation stack</code> operation to create new Amazon EC2 instances.</p> <p>Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.</p> <p/> <p>The <code>export snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>source snapshot name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p> <note> <p>Use the <code>get instance snapshots</code> or <code>get disk snapshots</code> operations to get a list of snapshots that you can export to Amazon EC2.</p> </note>" }, "GetActiveNames":{ "name":"GetActiveNames", @@ -1173,7 +1173,7 @@ {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"} ], - "documentation":"<p>Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.</p> <p>An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p>" + "documentation":"<p>Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.</p> <p>An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p>" }, "GetAutoSnapshots":{ "name":"GetAutoSnapshots", @@ -1191,7 +1191,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Returns the available automatic snapshots for an instance or disk. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Returns the available automatic snapshots for an instance or disk. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p>" }, "GetBlueprints":{ "name":"GetBlueprints", @@ -1277,7 +1277,7 @@ {"shape":"ServiceException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.</p> <p>For more information about buckets, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail\">Buckets in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.</p> <p>For more information about buckets, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/buckets-in-amazon-lightsail\">Buckets in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "GetBundles":{ "name":"GetBundles", @@ -1350,7 +1350,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>" + "documentation":"<p>Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>" }, "GetContainerAPIMetadata":{ "name":"GetContainerAPIMetadata", @@ -1727,7 +1727,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Returns temporary SSH keys you can use to connect to a specific virtual private server, or <i>instance</i>.</p> <p>The <code>get instance access details</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Returns temporary SSH keys you can use to connect to a specific virtual private server, or <i>instance</i>.</p> <p>The <code>get instance access details</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "GetInstanceMetricData":{ "name":"GetInstanceMetricData", @@ -1953,7 +1953,7 @@ {"shape":"UnauthenticatedException"}, {"shape":"InvalidInputException"} ], - "documentation":"<p>Returns a list of TLS security policies that you can apply to Lightsail load balancers.</p> <p>For more information about load balancer TLS security policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Configuring TLS security policies on your Amazon Lightsail load balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Returns a list of TLS security policies that you can apply to Lightsail load balancers.</p> <p>For more information about load balancer TLS security policies, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configure-load-balancer-tls-security-policy\">Configuring TLS security policies on your Amazon Lightsail load balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "GetLoadBalancers":{ "name":"GetLoadBalancers", @@ -2388,7 +2388,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.</p> <p>The <code>OpenInstancePublicPorts</code> action supports tag-based access control via resource tags applied to the resource identified by <code>instanceName</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.</p> <p>The <code>OpenInstancePublicPorts</code> action supports tag-based access control via resource tags applied to the resource identified by <code>instanceName</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "PeerVpc":{ "name":"PeerVpc", @@ -2425,7 +2425,7 @@ {"shape":"UnauthenticatedException"}, {"shape":"NotFoundException"} ], - "documentation":"<p>Creates or updates an alarm, and associates it with the specified metric.</p> <p>An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p> <p>When this action creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.</p> <p>When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.</p>" + "documentation":"<p>Creates or updates an alarm, and associates it with the specified metric.</p> <p>An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p> <p>When this action creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.</p> <p>When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.</p>" }, "PutInstancePublicPorts":{ "name":"PutInstancePublicPorts", @@ -2444,7 +2444,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your <code>PutInstancePublicPorts</code>request. Or use the <code>OpenInstancePublicPorts</code> action to open ports without closing currently open ports.</p> <p>The <code>PutInstancePublicPorts</code> action supports tag-based access control via resource tags applied to the resource identified by <code>instanceName</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your <code>PutInstancePublicPorts</code>request. Or use the <code>OpenInstancePublicPorts</code> action to open ports without closing currently open ports.</p> <p>The <code>PutInstancePublicPorts</code> action supports tag-based access control via resource tags applied to the resource identified by <code>instanceName</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "RebootInstance":{ "name":"RebootInstance", @@ -2463,7 +2463,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Restarts a specific instance.</p> <p>The <code>reboot instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Restarts a specific instance.</p> <p>The <code>reboot instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "RebootRelationalDatabase":{ "name":"RebootRelationalDatabase", @@ -2482,7 +2482,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Restarts a specific database in Amazon Lightsail.</p> <p>The <code>reboot relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Restarts a specific database in Amazon Lightsail.</p> <p>The <code>reboot relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "RegisterContainerImage":{ "name":"RegisterContainerImage", @@ -2499,7 +2499,7 @@ {"shape":"AccessDeniedException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Registers a container image to your Amazon Lightsail container service.</p> <note> <p>This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images\">Pushing and managing container images on your Amazon Lightsail container services</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> </note>" + "documentation":"<p>Registers a container image to your Amazon Lightsail container service.</p> <note> <p>This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-pushing-container-images\">Pushing and managing container images on your Amazon Lightsail container services</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> </note>" }, "ReleaseStaticIp":{ "name":"ReleaseStaticIp", @@ -2554,7 +2554,7 @@ {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"} ], - "documentation":"<p>Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p> <p>A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.</p> <important> <p>Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.</p> </important>" + "documentation":"<p>Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.</p> <p>A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p> <p>A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.</p> <important> <p>Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.</p> </important>" }, "SetIpAddressType":{ "name":"SetIpAddressType", @@ -2643,7 +2643,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the <code>reboot instance</code> operation.</p> <note> <p>When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-create-static-ip\">Amazon Lightsail Developer Guide</a>.</p> </note> <p>The <code>start instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the <code>reboot instance</code> operation.</p> <note> <p>When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/lightsail-create-static-ip\">Amazon Lightsail Developer Guide</a>.</p> </note> <p>The <code>start instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "StartRelationalDatabase":{ "name":"StartRelationalDatabase", @@ -2662,7 +2662,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the <code>reboot relational database</code> operation.</p> <p>The <code>start relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the <code>reboot relational database</code> operation.</p> <p>The <code>start relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "StopGUISession":{ "name":"StopGUISession", @@ -2679,7 +2679,7 @@ {"shape":"ServiceException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.</p>" + "documentation":"<p>Terminates a web-based Amazon DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.</p>" }, "StopInstance":{ "name":"StopInstance", @@ -2698,7 +2698,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Stops a specific Amazon Lightsail instance that is currently running.</p> <note> <p>When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-create-static-ip\">Amazon Lightsail Developer Guide</a>.</p> </note> <p>The <code>stop instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Stops a specific Amazon Lightsail instance that is currently running.</p> <note> <p>When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/lightsail-create-static-ip\">Amazon Lightsail Developer Guide</a>.</p> </note> <p>The <code>stop instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "StopRelationalDatabase":{ "name":"StopRelationalDatabase", @@ -2717,7 +2717,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Stops a specific database that is currently running in Amazon Lightsail.</p> <p>The <code>stop relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Stops a specific database that is currently running in Amazon Lightsail.</p> <note> <p>If you don't manually start your database instance after it has been stopped for seven consecutive days, Amazon Lightsail automatically starts it for you. This action helps ensure that your database instance doesn't fall behind on any required maintenance updates.</p> </note> <p>The <code>stop relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "TagResource":{ "name":"TagResource", @@ -2736,7 +2736,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p> <p>The <code>tag resource</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>resource name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p> <p>The <code>tag resource</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>resource name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "TestAlarm":{ "name":"TestAlarm", @@ -2754,7 +2754,7 @@ {"shape":"AccessDeniedException"}, {"shape":"NotFoundException"} ], - "documentation":"<p>Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (<code>Email</code> and/or <code>SMS</code>) configured for the alarm.</p> <p>An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p>" + "documentation":"<p>Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (<code>Email</code> and/or <code>SMS</code>) configured for the alarm.</p> <p>An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p>" }, "UnpeerVpc":{ "name":"UnpeerVpc", @@ -2792,7 +2792,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.</p> <p>The <code>untag resource</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>resource name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.</p> <p>The <code>untag resource</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>resource name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "UpdateBucket":{ "name":"UpdateBucket", @@ -2898,7 +2898,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Updates a domain recordset after it is created.</p> <p>The <code>update domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Updates a domain recordset after it is created.</p> <p>The <code>update domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "UpdateInstanceMetadataOptions":{ "name":"UpdateInstanceMetadataOptions", @@ -2917,7 +2917,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the <code>GetInstance</code> or <code>GetInstances</code> API operation initially responds with a state of <code>pending</code>. After the parameter modifications are successfully applied, the state changes to <code>applied</code> in subsequent <code>GetInstance</code> or <code>GetInstances</code> API calls. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-instance-metadata-service\">Use IMDSv2 with an Amazon Lightsail instance</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the <code>GetInstance</code> or <code>GetInstances</code> API operation initially responds with a state of <code>pending</code>. After the parameter modifications are successfully applied, the state changes to <code>applied</code> in subsequent <code>GetInstance</code> or <code>GetInstances</code> API calls. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-instance-metadata-service\">Use IMDSv2 with an Amazon Lightsail instance</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "UpdateLoadBalancerAttribute":{ "name":"UpdateLoadBalancerAttribute", @@ -2936,7 +2936,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Updates the specified attribute for a load balancer. You can only update one attribute at a time.</p> <p>The <code>update load balancer attribute</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Updates the specified attribute for a load balancer. You can only update one attribute at a time.</p> <p>The <code>update load balancer attribute</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "UpdateRelationalDatabase":{ "name":"UpdateRelationalDatabase", @@ -2955,7 +2955,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Allows the update of one or more attributes of a database in Amazon Lightsail.</p> <p>Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.</p> <p>The <code>update relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Allows the update of one or more attributes of a database in Amazon Lightsail.</p> <p>Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.</p> <p>The <code>update relational database</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "UpdateRelationalDatabaseParameters":{ "name":"UpdateRelationalDatabaseParameters", @@ -2974,7 +2974,7 @@ {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], - "documentation":"<p>Allows the update of one or more parameters of a database in Amazon Lightsail.</p> <p>Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: <code>dynamic</code> or <code>pending-reboot</code>. Parameters marked with a <code>dynamic</code> apply type are applied immediately. Parameters marked with a <code>pending-reboot</code> apply type are applied only after the database is rebooted using the <code>reboot relational database</code> operation.</p> <p>The <code>update relational database parameters</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Allows the update of one or more parameters of a database in Amazon Lightsail.</p> <p>Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: <code>dynamic</code> or <code>pending-reboot</code>. Parameters marked with a <code>dynamic</code> apply type are applied immediately. Parameters marked with a <code>pending-reboot</code> apply type are applied only after the database is rebooted using the <code>reboot relational database</code> operation.</p> <p>The <code>update relational database parameters</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags\">Amazon Lightsail Developer Guide</a>.</p>" } }, "shapes":{ @@ -3020,7 +3020,7 @@ "documentation":"<p>An object that describes the last time the access key was used.</p> <note> <p>This object does not include data in the response of a <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html\">CreateBucketAccessKey</a> action. If the access key has not been used, the <code>region</code> and <code>serviceName</code> values are <code>N/A</code>, and the <code>lastUsedDate</code> value is null.</p> </note>" } }, - "documentation":"<p>Describes an access key for an Amazon Lightsail bucket.</p> <p>Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html\">CreateBucketAccessKey</a> action to create an access key for a specific bucket. For more information about access keys, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> <important> <p>The <code>secretAccessKey</code> value is returned only in response to the <code>CreateBucketAccessKey</code> action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.</p> </important>" + "documentation":"<p>Describes an access key for an Amazon Lightsail bucket.</p> <p>Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html\">CreateBucketAccessKey</a> action to create an access key for a specific bucket. For more information about access keys, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-creating-bucket-access-keys\">Creating access keys for a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> <important> <p>The <code>secretAccessKey</code> value is returned only in response to the <code>CreateBucketAccessKey</code> action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.</p> </important>" }, "AccessKeyLastUsed":{ "type":"structure", @@ -3060,7 +3060,7 @@ "documentation":"<p>A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the <code>getObject</code> option that is currently specified.</p> <p>When this is true, you can use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectAcl.html\">PutObjectAcl</a> Amazon S3 API action to set individual objects to public (read-only) using the <code>public-read</code> ACL, or to private using the <code>private</code> ACL.</p>" } }, - "documentation":"<p>Describes the anonymous access permissions for an Amazon Lightsail bucket and its objects.</p> <p>For more information about bucket access permissions, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-understanding-bucket-permissions\">Understanding bucket permissions in Amazon Lightsail</a> in the </p> <p> <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes the anonymous access permissions for an Amazon Lightsail bucket and its objects.</p> <p>For more information about bucket access permissions, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-understanding-bucket-permissions\">Understanding bucket permissions in Amazon Lightsail</a> in the </p> <p> <i>Amazon Lightsail Developer Guide</i>.</p>" }, "AccessType":{ "type":"string", @@ -3082,14 +3082,14 @@ }, "message":{ "shape":"BPAStatusMessage", - "documentation":"<p>A message that provides a reason for a <code>Failed</code> or <code>Defaulted</code> synchronization status.</p> <p>The following messages are possible:</p> <ul> <li> <p> <code>SYNC_ON_HOLD</code> - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.</p> </li> <li> <p> <code>DEFAULTED_FOR_SLR_MISSING</code> - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to <i>active</i> until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles\">Using Service-Linked Roles for Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> </li> <li> <p> <code>DEFAULTED_FOR_SLR_MISSING_ON_HOLD</code> - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-using-service-linked-roles\">Using Service-Linked Roles for Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> </li> <li> <p> <code>Unknown</code> - The reason that synchronization failed is unknown. Contact Amazon Web Services Support for more information.</p> </li> </ul>" + "documentation":"<p>A message that provides a reason for a <code>Failed</code> or <code>Defaulted</code> synchronization status.</p> <p>The following messages are possible:</p> <ul> <li> <p> <code>SYNC_ON_HOLD</code> - The synchronization has not yet happened. This status message occurs immediately after you create your first Lightsail bucket. This status message should change after the first synchronization happens, approximately 1 hour after the first bucket is created.</p> </li> <li> <p> <code>DEFAULTED_FOR_SLR_MISSING</code> - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. The account-level BPA configuration for your Lightsail buckets is defaulted to <i>active</i> until the synchronization can occur. This means that all your buckets are private and not publicly accessible. For more information about how to create the required service-linked role to allow synchronization, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-using-service-linked-roles\">Using Service-Linked Roles for Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> </li> <li> <p> <code>DEFAULTED_FOR_SLR_MISSING_ON_HOLD</code> - The synchronization failed because the required service-linked role is missing from your Amazon Web Services account. Account-level BPA is not yet configured for your Lightsail buckets. Therefore, only the bucket access permissions and individual object access permissions apply to your Lightsail buckets. For more information about how to create the required service-linked role to allow synchronization, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-using-service-linked-roles\">Using Service-Linked Roles for Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> </li> <li> <p> <code>Unknown</code> - The reason that synchronization failed is unknown. Contact Amazon Web ServicesSupport for more information.</p> </li> </ul>" }, "bpaImpactsLightsail":{ "shape":"boolean", "documentation":"<p>A Boolean value that indicates whether account-level block public access is affecting your Lightsail buckets.</p>" } }, - "documentation":"<p>Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access (BPA) feature for your Lightsail buckets.</p> <p>The account-level BPA feature of Amazon S3 provides centralized controls to limit public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and object permissions that are configured. Lightsail buckets take into account the Amazon S3 account-level BPA configuration when allowing or denying public access. To do this, Lightsail periodically fetches the account-level BPA configuration from Amazon S3. When the account-level BPA status is <code>InSync</code>, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects Lightsail buckets, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets\">Block public access for buckets in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access (BPA) feature for your Lightsail buckets.</p> <p>The account-level BPA feature of Amazon S3 provides centralized controls to limit public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and object permissions that are configured. Lightsail buckets take into account the Amazon S3 account-level BPA configuration when allowing or denying public access. To do this, Lightsail periodically fetches the account-level BPA configuration from Amazon S3. When the account-level BPA status is <code>InSync</code>, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects Lightsail buckets, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-block-public-access-for-buckets\">Block public access for buckets in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "AccountLevelBpaSyncStatus":{ "type":"string", @@ -3259,7 +3259,7 @@ "documentation":"<p>Indicates whether the alarm is enabled.</p>" } }, - "documentation":"<p>Describes an alarm.</p> <p>An alarm is a way to monitor your Lightsail resource metrics. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p>" + "documentation":"<p>Describes an alarm.</p> <p>An alarm is a way to monitor your Lightsail resource metrics. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p>" }, "AlarmState":{ "type":"string", @@ -3711,7 +3711,7 @@ "documentation":"<p>The optional object prefix for the bucket access log.</p> <p>The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a <code>logs/</code> prefix, then each log object will begin with the <code>logs/</code> prefix in its key (for example, <code>logs/2021-11-01-21-32-16-E568B2907131C0C0</code>).</p> <note> <p>This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.</p> </note>" } }, - "documentation":"<p>Describes the access log configuration for a bucket in the Amazon Lightsail object storage service.</p> <p>For more information about bucket access logs, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-bucket-access-logs\">Logging bucket requests using access logging in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes the access log configuration for a bucket in the Amazon Lightsail object storage service.</p> <p>For more information about bucket access logs, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-bucket-access-logs\">Logging bucket requests using access logging in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "BucketAccessLogPrefix":{ "type":"string", @@ -3993,7 +3993,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "supportCode":{ "shape":"string", @@ -4052,7 +4052,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" } }, "documentation":"<p>Describes an Amazon Lightsail SSL/TLS certificate.</p>" @@ -4204,7 +4204,7 @@ "documentation":"<p>The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.</p>" } }, - "documentation":"<p>Describes a contact method.</p> <p>A contact method is a way to send you notifications. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>" + "documentation":"<p>Describes a contact method.</p> <p>A contact method is a way to send you notifications. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>" }, "ContactMethodStatus":{ "type":"string", @@ -4319,7 +4319,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "power":{ "shape":"ContainerServicePowerName", @@ -4371,7 +4371,7 @@ }, "privateRegistryAccess":{ "shape":"PrivateRegistryAccess", - "documentation":"<p>An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>An object that describes the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" } }, "documentation":"<p>Describes an Amazon Lightsail container service.</p>" @@ -4441,7 +4441,7 @@ "documentation":"<p>The Amazon Resource Name (ARN) of the role, if it is activated.</p>" } }, - "documentation":"<p>Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "ContainerServiceECRImagePullerRoleRequest":{ "type":"structure", @@ -4451,7 +4451,7 @@ "documentation":"<p>A Boolean value that indicates whether to activate the role.</p>" } }, - "documentation":"<p>Describes a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "ContainerServiceEndpoint":{ "type":"structure", @@ -4711,15 +4711,15 @@ }, "sourceResourceName":{ "shape":"string", - "documentation":"<p>The name of the source instance or disk from which the source automatic snapshot was created.</p> <p>Constraint:</p> <ul> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" + "documentation":"<p>The name of the source instance or disk from which the source automatic snapshot was created.</p> <p>Constraint:</p> <ul> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-keeping-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" }, "restoreDate":{ "shape":"string", - "documentation":"<p>The date of the source automatic snapshot to copy. Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" + "documentation":"<p>The date of the source automatic snapshot to copy. Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-keeping-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" }, "useLatestRestorableAutoSnapshot":{ "shape":"boolean", - "documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" + "documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-keeping-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" }, "targetSnapshotName":{ "shape":"ResourceName", @@ -4790,7 +4790,7 @@ "members":{ "bucketName":{ "shape":"BucketName", - "documentation":"<p>The name for the bucket.</p> <p>For more information about bucket names, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/bucket-naming-rules-in-amazon-lightsail\">Bucket naming rules in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>The name for the bucket.</p> <p>For more information about bucket names, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/bucket-naming-rules-in-amazon-lightsail\">Bucket naming rules in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "bundleId":{ "shape":"NonEmptyString", @@ -4802,7 +4802,7 @@ }, "enableObjectVersioning":{ "shape":"boolean", - "documentation":"<p>A Boolean value that indicates whether to enable versioning of objects in the bucket.</p> <p>For more information about versioning, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-managing-bucket-object-versioning\">Enabling and suspending object versioning in a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>A Boolean value that indicates whether to enable versioning of objects in the bucket.</p> <p>For more information about versioning, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-managing-bucket-object-versioning\">Enabling and suspending object versioning in a bucket in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" } } }, @@ -4885,7 +4885,7 @@ "members":{ "protocol":{ "shape":"ContactProtocol", - "documentation":"<p>The protocol of the contact method, such as <code>Email</code> or <code>SMS</code> (text messaging).</p> <p>The <code>SMS</code> protocol is supported only in the following Amazon Web Services Regions.</p> <ul> <li> <p>US East (N. Virginia) (<code>us-east-1</code>)</p> </li> <li> <p>US West (Oregon) (<code>us-west-2</code>)</p> </li> <li> <p>Europe (Ireland) (<code>eu-west-1</code>)</p> </li> <li> <p>Asia Pacific (Tokyo) (<code>ap-northeast-1</code>)</p> </li> <li> <p>Asia Pacific (Singapore) (<code>ap-southeast-1</code>)</p> </li> <li> <p>Asia Pacific (Sydney) (<code>ap-southeast-2</code>)</p> </li> </ul> <p>For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html\">Supported Regions and Countries</a> in the <i>Amazon SNS Developer Guide</i>.</p> <p>For more information about notifications in Amazon Lightsail, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>" + "documentation":"<p>The protocol of the contact method, such as <code>Email</code> or <code>SMS</code> (text messaging).</p> <p>The <code>SMS</code> protocol is supported only in the following Amazon Web Services Regions.</p> <ul> <li> <p>US East (N. Virginia) (<code>us-east-1</code>)</p> </li> <li> <p>US West (Oregon) (<code>us-west-2</code>)</p> </li> <li> <p>Europe (Ireland) (<code>eu-west-1</code>)</p> </li> <li> <p>Asia Pacific (Tokyo) (<code>ap-northeast-1</code>)</p> </li> <li> <p>Asia Pacific (Singapore) (<code>ap-southeast-1</code>)</p> </li> <li> <p>Asia Pacific (Sydney) (<code>ap-southeast-2</code>)</p> </li> </ul> <p>For a list of countries/regions where SMS text messages can be sent, and the latest Amazon Web Services Regions where SMS text messaging is supported, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html\">Supported Regions and Countries</a> in the <i>Amazon SNS Developer Guide</i>.</p> <p>For more information about notifications in Amazon Lightsail, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications\">Notifications in Amazon Lightsail</a>.</p>" }, "contactEndpoint":{ "shape":"StringMax256", @@ -4965,7 +4965,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values to add to the container service during create.</p> <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p> <p>For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values to add to the container service during create.</p> <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p> <p>For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "publicDomainNames":{ "shape":"ContainerServicePublicDomains", @@ -4977,7 +4977,7 @@ }, "privateRegistryAccess":{ "shape":"PrivateRegistryAccessRequest", - "documentation":"<p>An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" } } }, @@ -5024,15 +5024,15 @@ }, "sourceDiskName":{ "shape":"string", - "documentation":"<p>The name of the source disk from which the source automatic snapshot was created.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>disk snapshot name</code> parameter. The <code>source disk name</code> and <code>disk snapshot name</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" + "documentation":"<p>The name of the source disk from which the source automatic snapshot was created.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>disk snapshot name</code> parameter. The <code>source disk name</code> and <code>disk snapshot name</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" }, "restoreDate":{ "shape":"string", - "documentation":"<p>The date of the automatic snapshot to use for the new disk. Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" + "documentation":"<p>The date of the automatic snapshot to use for the new disk. Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" }, "useLatestRestorableAutoSnapshot":{ "shape":"boolean", - "documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" + "documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" } } }, @@ -5259,7 +5259,7 @@ }, "sessions":{ "shape":"Sessions", - "documentation":"<p>Returns information about the specified NICE DCV GUI session.</p>" + "documentation":"<p>Returns information about the specified Amazon DCV GUI session.</p>" } } }, @@ -5323,7 +5323,7 @@ }, "userData":{ "shape":"string", - "documentation":"<p>You can create a launch script that configures a server with additional user data. For example, <code>apt-get -y update</code>.</p> <note> <p>Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use <code>yum</code>, Debian and Ubuntu use <code>apt-get</code>, and FreeBSD uses <code>pkg</code>. For a complete list, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image\">Amazon Lightsail Developer Guide</a>.</p> </note>" + "documentation":"<p>You can create a launch script that configures a server with additional user data. For example, <code>apt-get -y update</code>.</p> <note> <p>Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use <code>yum</code>, Debian and Ubuntu use <code>apt-get</code>, and FreeBSD uses <code>pkg</code>. For a complete list, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/compare-options-choose-lightsail-instance-image\">Amazon Lightsail Developer Guide</a>.</p> </note>" }, "keyPairName":{ "shape":"ResourceName", @@ -5343,15 +5343,15 @@ }, "sourceInstanceName":{ "shape":"string", - "documentation":"<p>The name of the source instance from which the source automatic snapshot was created.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>instance snapshot name</code> parameter. The <code>source instance name</code> and <code>instance snapshot name</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" + "documentation":"<p>The name of the source instance from which the source automatic snapshot was created.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>instance snapshot name</code> parameter. The <code>source instance name</code> and <code>instance snapshot name</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" }, "restoreDate":{ "shape":"string", - "documentation":"<p>The date of the automatic snapshot to use for the new instance. Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" + "documentation":"<p>The date of the automatic snapshot to use for the new instance. Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" }, "useLatestRestorableAutoSnapshot":{ "shape":"boolean", - "documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" + "documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>Constraints:</p> <ul> <li> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> </li> <li> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots\">Amazon Lightsail Developer Guide</a>.</p> </li> </ul>" } } }, @@ -5396,7 +5396,7 @@ }, "userData":{ "shape":"string", - "documentation":"<p>A launch script you can create that configures a server with additional user data. For example, you might want to run <code>apt-get -y update</code>.</p> <note> <p>Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use <code>yum</code>, Debian and Ubuntu use <code>apt-get</code>, and FreeBSD uses <code>pkg</code>. For a complete list, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/compare-options-choose-lightsail-instance-image\">Amazon Lightsail Developer Guide</a>.</p> </note>" + "documentation":"<p>A launch script you can create that configures a server with additional user data. For example, you might want to run <code>apt-get -y update</code>.</p> <note> <p>Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use <code>yum</code>, Debian and Ubuntu use <code>apt-get</code>, and FreeBSD uses <code>pkg</code>. For a complete list, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/compare-options-choose-lightsail-instance-image\">Amazon Lightsail Developer Guide</a>.</p> </note>" }, "keyPairName":{ "shape":"ResourceName", @@ -5501,7 +5501,7 @@ }, "tlsPolicyName":{ "shape":"string", - "documentation":"<p>The name of the TLS policy to apply to the load balancer.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html\">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you can specify.</p> <p>For more information about load balancer TLS policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Configuring TLS security policies on your Amazon Lightsail load balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>The name of the TLS policy to apply to the load balancer.</p> <p>Use the <a href=\"https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html\">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you can specify.</p> <p>For more information about load balancer TLS policies, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configure-load-balancer-tls-security-policy\">Configuring TLS security policies on your Amazon Lightsail load balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" } } }, @@ -6308,7 +6308,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "addOns":{ "shape":"AddOnList", @@ -6436,7 +6436,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "sizeInGb":{ "shape":"integer", @@ -6563,7 +6563,7 @@ "documentation":"<p>The message that describes the reason for the status code.</p>" } }, - "documentation":"<p>Describes the creation state of the canonical name (CNAME) records that are automatically added by Amazon Lightsail to the DNS of a domain to validate domain ownership for an SSL/TLS certificate.</p> <p>When you create an SSL/TLS certificate for a Lightsail resource, you must add a set of CNAME records to the DNS of the domains for the certificate to validate that you own the domains. Lightsail can automatically add the CNAME records to the DNS of the domain if the DNS zone for the domain exists within your Lightsail account. If automatic record addition fails, or if you manage the DNS of your domain using a third-party service, then you must manually add the CNAME records to the DNS of your domain. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/verify-tls-ssl-certificate-using-dns-cname-https\">Verify an SSL/TLS certificate in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes the creation state of the canonical name (CNAME) records that are automatically added by Amazon Lightsail to the DNS of a domain to validate domain ownership for an SSL/TLS certificate.</p> <p>When you create an SSL/TLS certificate for a Lightsail resource, you must add a set of CNAME records to the DNS of the domains for the certificate to validate that you own the domains. Lightsail can automatically add the CNAME records to the DNS of the domain if the DNS zone for the domain exists within your Lightsail account. If automatic record addition fails, or if you manage the DNS of your domain using a third-party service, then you must manually add the CNAME records to the DNS of your domain. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/verify-tls-ssl-certificate-using-dns-cname-https\">Verify an SSL/TLS certificate in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "DnsRecordCreationStateCode":{ "type":"string", @@ -6602,7 +6602,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "domainEntries":{ "shape":"DomainEntryList", @@ -7150,7 +7150,7 @@ }, "accountLevelBpaSync":{ "shape":"AccountLevelBpaSync", - "documentation":"<p>An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.</p> <p>For more information about this feature and how it affects Lightsail buckets, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets\">Block public access for buckets in Amazon Lightsail</a>.</p>" + "documentation":"<p>An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets.</p> <p>For more information about this feature and how it affects Lightsail buckets, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-block-public-access-for-buckets\">Block public access for buckets in Amazon Lightsail</a>.</p>" } } }, @@ -7763,7 +7763,7 @@ }, "metricName":{ "shape":"InstanceMetricName", - "documentation":"<p>The metric for which you want to return information.</p> <p>Valid instance metric names are listed below, along with the most useful <code>statistics</code> to include in your request, and the published <code>unit</code> value.</p> <ul> <li> <p> <b> <code>BurstCapacityPercentage</code> </b> - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance's <code>BurstCapacityPercentage</code> reaches 100%. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity\">Viewing instance burst capacity in Amazon Lightsail</a>.</p> <p> <code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Average</code>.</p> <p> <code>Unit</code>: The published unit is <code>Percent</code>.</p> </li> <li> <p> <b> <code>BurstCapacityTime</code> </b> - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance's <code>BurstCapacityPercentage</code> metric reaches 100%.</p> <p>Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-burst-capacity\">Viewing instance burst capacity in Amazon Lightsail</a>.</p> <p> <code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Average</code>.</p> <p> <code>Unit</code>: The published unit is <code>Seconds</code>.</p> </li> <li> <p> <b> <code>CPUUtilization</code> </b> - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.</p> <p> <code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Average</code>.</p> <p> <code>Unit</code>: The published unit is <code>Percent</code>.</p> </li> <li> <p> <b> <code>NetworkIn</code> </b> - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Bytes</code>.</p> </li> <li> <p> <b> <code>NetworkOut</code> </b> - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Bytes</code>.</p> </li> <li> <p> <b> <code>StatusCheckFailed</code> </b> - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Count</code>.</p> </li> <li> <p> <b> <code>StatusCheckFailed_Instance</code> </b> - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Count</code>.</p> </li> <li> <p> <b> <code>StatusCheckFailed_System</code> </b> - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Count</code>.</p> </li> <li> <p> <b> <code>MetadataNoToken</code> </b> - Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn't use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Count</code>.</p> </li> </ul>" + "documentation":"<p>The metric for which you want to return information.</p> <p>Valid instance metric names are listed below, along with the most useful <code>statistics</code> to include in your request, and the published <code>unit</code> value.</p> <ul> <li> <p> <b> <code>BurstCapacityPercentage</code> </b> - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance's <code>BurstCapacityPercentage</code> reaches 100%. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-viewing-instance-burst-capacity\">Viewing instance burst capacity in Amazon Lightsail</a>.</p> <p> <code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Average</code>.</p> <p> <code>Unit</code>: The published unit is <code>Percent</code>.</p> </li> <li> <p> <b> <code>BurstCapacityTime</code> </b> - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance's <code>BurstCapacityPercentage</code> metric reaches 100%.</p> <p>Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-viewing-instance-burst-capacity\">Viewing instance burst capacity in Amazon Lightsail</a>.</p> <p> <code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Average</code>.</p> <p> <code>Unit</code>: The published unit is <code>Seconds</code>.</p> </li> <li> <p> <b> <code>CPUUtilization</code> </b> - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.</p> <p> <code>Statistics</code>: The most useful statistics are <code>Maximum</code> and <code>Average</code>.</p> <p> <code>Unit</code>: The published unit is <code>Percent</code>.</p> </li> <li> <p> <b> <code>NetworkIn</code> </b> - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Bytes</code>.</p> </li> <li> <p> <b> <code>NetworkOut</code> </b> - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Bytes</code>.</p> </li> <li> <p> <b> <code>StatusCheckFailed</code> </b> - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Count</code>.</p> </li> <li> <p> <b> <code>StatusCheckFailed_Instance</code> </b> - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Count</code>.</p> </li> <li> <p> <b> <code>StatusCheckFailed_System</code> </b> - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Count</code>.</p> </li> <li> <p> <b> <code>MetadataNoToken</code> </b> - Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn't use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> <p> <code>Unit</code>: The published unit is <code>Count</code>.</p> </li> </ul>" }, "period":{ "shape":"MetricPeriod", @@ -8787,7 +8787,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "blueprintId":{ "shape":"NonEmptyString", @@ -9025,7 +9025,7 @@ }, "httpTokens":{ "shape":"HttpTokens", - "documentation":"<p>The state of token usage for your instance metadata requests.</p> <p>If the state is <code>optional</code>, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.</p> <p>If the state is <code>required</code>, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.</p> <important> <p>Not all instance blueprints in Lightsail support version 2.0 credentials. Use the <code>MetadataNoToken</code> instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-viewing-instance-health-metrics\">Viewing instance metrics in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> </important>" + "documentation":"<p>The state of token usage for your instance metadata requests.</p> <p>If the state is <code>optional</code>, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.</p> <p>If the state is <code>required</code>, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.</p> <important> <p>Not all instance blueprints in Lightsail support version 2.0 credentials. Use the <code>MetadataNoToken</code> instance metric to track the number of calls to the instance metadata service that are using version 1.0 credentials. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-viewing-instance-health-metrics\">Viewing instance metrics in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p> </important>" }, "httpEndpoint":{ "shape":"HttpEndpoint", @@ -9205,7 +9205,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "state":{ "shape":"InstanceSnapshotState", @@ -9367,7 +9367,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "fingerprint":{ "shape":"Base64", @@ -9461,7 +9461,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "viewerMinimumTlsProtocolVersion":{ "shape":"string", @@ -9499,7 +9499,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "dnsName":{ "shape":"NonEmptyString", @@ -9634,7 +9634,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "loadBalancerName":{ "shape":"ResourceName", @@ -9900,7 +9900,7 @@ "documentation":"<p>The ciphers used by the TLS security policy.</p> <p>The ciphers are listed in order of preference.</p>" } }, - "documentation":"<p>Describes the TLS security policies that are available for Lightsail load balancers.</p> <p>For more information about load balancer TLS security policies, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy\">Configuring TLS security policies on your Amazon Lightsail load balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes the TLS security policies that are available for Lightsail load balancers.</p> <p>For more information about load balancer TLS security policies, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configure-load-balancer-tls-security-policy\">Configuring TLS security policies on your Amazon Lightsail load balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "LoadBalancerTlsPolicyList":{ "type":"list", @@ -10059,7 +10059,7 @@ "documentation":"<p>The Lightsail resource type of the resource being monitored.</p> <p>Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.</p>" } }, - "documentation":"<p>Describes resource being monitored by an alarm.</p> <p>An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p>" + "documentation":"<p>Describes resource being monitored by an alarm.</p> <p>An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms\">Alarms in Amazon Lightsail</a>.</p>" }, "MonthlyTransfer":{ "type":"structure", @@ -10083,7 +10083,7 @@ "documentation":"<p>The message that describes the reason for the status code.</p>" } }, - "documentation":"<p>Describes the state of the name server records update made by Amazon Lightsail to an Amazon Route 53 registered domain.</p> <p>For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-dns-in-amazon-lightsail\">DNS in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes the state of the name server records update made by Amazon Lightsail to an Amazon Route 53 registered domain.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-dns-in-amazon-lightsail\">DNS in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "NameServersUpdateStateCode":{ "type":"string", @@ -10511,7 +10511,7 @@ "documentation":"<p>An object that describes the activation status of the role that you can use to grant a Lightsail container service access to Amazon ECR private repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also listed.</p>" } }, - "documentation":"<p>Describes the configuration for an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes the configuration for an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "PrivateRegistryAccessRequest":{ "type":"structure", @@ -10521,7 +10521,7 @@ "documentation":"<p>An object to describe a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.</p>" } }, - "documentation":"<p>Describes a request to configure an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes a request to configure an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "PutAlarmRequest":{ "type":"structure", @@ -10540,7 +10540,7 @@ }, "metricName":{ "shape":"MetricName", - "documentation":"<p>The name of the metric to associate with the alarm.</p> <p>You can configure up to two alarms per metric.</p> <p>The following metrics are available for each resource type:</p> <ul> <li> <p> <b>Instances</b>: <code>BurstCapacityPercentage</code>, <code>BurstCapacityTime</code>, <code>CPUUtilization</code>, <code>NetworkIn</code>, <code>NetworkOut</code>, <code>StatusCheckFailed</code>, <code>StatusCheckFailed_Instance</code>, and <code>StatusCheckFailed_System</code>.</p> </li> <li> <p> <b>Load balancers</b>: <code>ClientTLSNegotiationErrorCount</code>, <code>HealthyHostCount</code>, <code>UnhealthyHostCount</code>, <code>HTTPCode_LB_4XX_Count</code>, <code>HTTPCode_LB_5XX_Count</code>, <code>HTTPCode_Instance_2XX_Count</code>, <code>HTTPCode_Instance_3XX_Count</code>, <code>HTTPCode_Instance_4XX_Count</code>, <code>HTTPCode_Instance_5XX_Count</code>, <code>InstanceResponseTime</code>, <code>RejectedConnectionCount</code>, and <code>RequestCount</code>.</p> </li> <li> <p> <b>Relational databases</b>: <code>CPUUtilization</code>, <code>DatabaseConnections</code>, <code>DiskQueueDepth</code>, <code>FreeStorageSpace</code>, <code>NetworkReceiveThroughput</code>, and <code>NetworkTransmitThroughput</code>.</p> </li> </ul> <p>For more information about these metrics, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-resource-health-metrics#available-metrics\">Metrics available in Lightsail</a>.</p>" + "documentation":"<p>The name of the metric to associate with the alarm.</p> <p>You can configure up to two alarms per metric.</p> <p>The following metrics are available for each resource type:</p> <ul> <li> <p> <b>Instances</b>: <code>BurstCapacityPercentage</code>, <code>BurstCapacityTime</code>, <code>CPUUtilization</code>, <code>NetworkIn</code>, <code>NetworkOut</code>, <code>StatusCheckFailed</code>, <code>StatusCheckFailed_Instance</code>, and <code>StatusCheckFailed_System</code>.</p> </li> <li> <p> <b>Load balancers</b>: <code>ClientTLSNegotiationErrorCount</code>, <code>HealthyHostCount</code>, <code>UnhealthyHostCount</code>, <code>HTTPCode_LB_4XX_Count</code>, <code>HTTPCode_LB_5XX_Count</code>, <code>HTTPCode_Instance_2XX_Count</code>, <code>HTTPCode_Instance_3XX_Count</code>, <code>HTTPCode_Instance_4XX_Count</code>, <code>HTTPCode_Instance_5XX_Count</code>, <code>InstanceResponseTime</code>, <code>RejectedConnectionCount</code>, and <code>RequestCount</code>.</p> </li> <li> <p> <b>Relational databases</b>: <code>CPUUtilization</code>, <code>DatabaseConnections</code>, <code>DiskQueueDepth</code>, <code>FreeStorageSpace</code>, <code>NetworkReceiveThroughput</code>, and <code>NetworkTransmitThroughput</code>.</p> </li> </ul> <p>For more information about these metrics, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-resource-health-metrics#available-metrics\">Metrics available in Lightsail</a>.</p>" }, "monitoredResourceName":{ "shape":"ResourceName", @@ -10795,7 +10795,7 @@ "documentation":"<p>Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone.</p>" } }, - "documentation":"<p>Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail.</p> <p>When you delegate an Amazon Route 53 registered domain to Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You no longer use the Route 53 hosted zone to manage the DNS of the domain. To delegate the domain, Lightsail automatically updates the domain's name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the domain.</p> <p>All of the following conditions must be true for automatic domain delegation to be successful:</p> <ul> <li> <p>The registered domain must be in the same Amazon Web Services account as the Lightsail account making the request.</p> </li> <li> <p>The user or entity making the request must have permission to manage domains in Route 53.</p> </li> <li> <p>The Route 53 hosted zone for the domain must be empty. It cannot contain DNS records other than start of authority (SOA) and name server records.</p> </li> </ul> <p>If automatic domain delegation fails, or if you manage the DNS of your domain using a service other than Route 53, then you must manually add the Lightsail DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-create-dns-entry\">Creating a DNS zone to manage your domain’s records in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail.</p> <p>When you delegate an Amazon Route 53 registered domain to Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You no longer use the Route 53 hosted zone to manage the DNS of the domain. To delegate the domain, Lightsail automatically updates the domain's name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the domain.</p> <p>All of the following conditions must be true for automatic domain delegation to be successful:</p> <ul> <li> <p>The registered domain must be in the same Amazon Web Services account as the Lightsail account making the request.</p> </li> <li> <p>The user or entity making the request must have permission to manage domains in Route 53.</p> </li> <li> <p>The Route 53 hosted zone for the domain must be empty. It cannot contain DNS records other than start of authority (SOA) and name server records.</p> </li> </ul> <p>If automatic domain delegation fails, or if you manage the DNS of your domain using a service other than Route 53, then you must manually add the Lightsail DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/lightsail-how-to-create-dns-entry\">Creating a DNS zone to manage your domain’s records in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" }, "RelationalDatabase":{ "type":"structure", @@ -10826,7 +10826,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "relationalDatabaseBlueprintId":{ "shape":"NonEmptyString", @@ -11143,7 +11143,7 @@ }, "tags":{ "shape":"TagList", - "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "engine":{ "shape":"NonEmptyString", @@ -11440,7 +11440,7 @@ "documentation":"<p>When true, this Boolean value indicates the primary session for the specified resource.</p>" } }, - "documentation":"<p>Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual computer’s operating system or application.</p>" + "documentation":"<p>Describes a web-based, remote graphical user interface (GUI), Amazon DCV session. The session is used to access a virtual computer’s operating system or application.</p>" }, "Sessions":{ "type":"list", @@ -11908,7 +11908,7 @@ "documentation":"<p>The value of the tag.</p> <p>Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @</p>" } }, - "documentation":"<p>Describes a tag key and optional value assigned to an Amazon Lightsail resource.</p> <p>For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" + "documentation":"<p>Describes a tag key and optional value assigned to an Amazon Lightsail resource.</p> <p>For more information about tags in Lightsail, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags\">Amazon Lightsail Developer Guide</a>.</p>" }, "TagKey":{"type":"string"}, "TagKeyList":{ @@ -12149,7 +12149,7 @@ }, "privateRegistryAccess":{ "shape":"PrivateRegistryAccessRequest", - "documentation":"<p>An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" + "documentation":"<p>An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access\">Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>" } } }, @@ -12433,5 +12433,5 @@ "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, - "documentation":"<p>Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.</p> <p>You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli\">Amazon Lightsail Developer Guide</a>.</p> <p>This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/lightsail.html\">Amazon Lightsail Endpoints and Quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>" + "documentation":"<p>Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.</p> <p>You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the <a href=\"https://docs.aws.amazon.com/lightsail/latest/userguide/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli\">Amazon Lightsail Developer Guide</a>.</p> <p>This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/lightsail.html\">Amazon Lightsail Endpoints and Quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>" } diff --git a/contrib/python/botocore/py3/botocore/data/location/2020-11-19/service-2.json b/contrib/python/botocore/py3/botocore/data/location/2020-11-19/service-2.json index c9deaf2ba2b..87fca0df3e3 100644 --- a/contrib/python/botocore/py3/botocore/data/location/2020-11-19/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/location/2020-11-19/service-2.json @@ -2,6 +2,7 @@ "version":"2.0", "metadata":{ "apiVersion":"2020-11-19", + "auth":["aws.auth#sigv4"], "endpointPrefix":"geo", "protocol":"rest-json", "protocols":["rest-json"], @@ -1238,7 +1239,7 @@ "ApiKeyRestrictionsAllowActionsList":{ "type":"list", "member":{"shape":"ApiKeyAction"}, - "max":7, + "max":24, "min":1 }, "ApiKeyRestrictionsAllowReferersList":{ @@ -1250,7 +1251,7 @@ "ApiKeyRestrictionsAllowResourcesList":{ "type":"list", "member":{"shape":"GeoArnV2"}, - "max":5, + "max":8, "min":1 }, "Arn":{ @@ -2146,13 +2147,15 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"<p>This parameter is no longer used.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. No longer allowed." + "deprecatedMessage":"Deprecated. No longer allowed.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -2269,7 +2272,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -2322,7 +2326,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -2379,7 +2384,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -2425,7 +2431,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "KmsKeyId":{ "shape":"KmsKeyId", @@ -2435,7 +2442,8 @@ "shape":"String", "documentation":"<p>This parameter is no longer used.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. No longer allowed." + "deprecatedMessage":"Deprecated. No longer allowed.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -2649,13 +2657,15 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"<p>No longer used. Always returns an empty string.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Unused." + "deprecatedMessage":"Deprecated. Unused.", + "deprecatedSince":"2022-02-01" }, "KmsKeyId":{ "shape":"KmsKeyId", @@ -2779,7 +2789,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "DataSource":{ "shape":"String", @@ -2843,7 +2854,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -2906,7 +2918,8 @@ "shape":"PricingPlan", "documentation":"<p>Always returns <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -2968,13 +2981,15 @@ "shape":"PricingPlan", "documentation":"<p>Always returns <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"<p>No longer used. Always returns an empty string.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Unused." + "deprecatedMessage":"Deprecated. Unused.", + "deprecatedSince":"2022-02-01" }, "Tags":{ "shape":"TagMap", @@ -3035,7 +3050,7 @@ "documentation":"<p>The accuracy of the device position.</p>" }, "PositionProperties":{ - "shape":"PropertyMap", + "shape":"PositionPropertyMap", "documentation":"<p>The properties associated with the position.</p>" } }, @@ -3070,7 +3085,7 @@ "documentation":"<p>The accuracy of the device position.</p>" }, "PositionProperties":{ - "shape":"PropertyMap", + "shape":"PositionPropertyMap", "documentation":"<p>Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.</p> <p>Format: <code>\"key\" : \"value\"</code> </p>" } }, @@ -3462,7 +3477,7 @@ "documentation":"<p>The accuracy of the device position.</p>" }, "PositionProperties":{ - "shape":"PropertyMap", + "shape":"PositionPropertyMap", "documentation":"<p>The properties associated with the position.</p>" } } @@ -4010,7 +4025,7 @@ "documentation":"<p>The accuracy of the device position.</p>" }, "PositionProperties":{ - "shape":"PropertyMap", + "shape":"PositionPropertyMap", "documentation":"<p>The properties associated with the position.</p>" } }, @@ -4074,13 +4089,15 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"<p>No longer used. Always returns an empty string.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Unused." + "deprecatedMessage":"Deprecated. Unused.", + "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", @@ -4312,7 +4329,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", @@ -4388,7 +4406,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. Always returns <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", @@ -4464,7 +4483,8 @@ "shape":"PricingPlan", "documentation":"<p>Always returns <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", @@ -4596,13 +4616,15 @@ "shape":"PricingPlan", "documentation":"<p>Always returns <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage." + "deprecatedMessage":"Deprecated. Always returns RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"<p>No longer used. Always returns an empty string.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. Unused." + "deprecatedMessage":"Deprecated. Unused.", + "deprecatedSince":"2022-02-01" }, "CreateTime":{ "shape":"Timestamp", @@ -4930,6 +4952,24 @@ "AccuracyBased" ] }, + "PositionPropertyMap":{ + "type":"map", + "key":{"shape":"PositionPropertyMapKeyString"}, + "value":{"shape":"PositionPropertyMapValueString"}, + "max":4, + "min":0, + "sensitive":true + }, + "PositionPropertyMapKeyString":{ + "type":"string", + "max":20, + "min":1 + }, + "PositionPropertyMapValueString":{ + "type":"string", + "max":150, + "min":1 + }, "PositionalAccuracy":{ "type":"structure", "required":["Horizontal"], @@ -5633,7 +5673,7 @@ "type":"string", "max":128, "min":1, - "pattern":"[a-zA-Z+-=._:/]+" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)" }, "TagKeys":{ "type":"list", @@ -5676,7 +5716,7 @@ "type":"string", "max":256, "min":0, - "pattern":"[A-Za-z0-9 _=@:.+-/]*" + "pattern":"([\\p{L}\\p{Z}\\p{N}_.,:/=+\\-@]*)" }, "ThrottlingException":{ "type":"structure", @@ -5835,13 +5875,15 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"<p>This parameter is no longer used.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. No longer allowed." + "deprecatedMessage":"Deprecated. No longer allowed.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -5939,7 +5981,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -5987,7 +6030,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -6035,7 +6079,8 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -6079,13 +6124,15 @@ "shape":"PricingPlan", "documentation":"<p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage." + "deprecatedMessage":"Deprecated. If included, the only allowed value is RequestBasedUsage.", + "deprecatedSince":"2022-02-01" }, "PricingPlanDataSource":{ "shape":"String", "documentation":"<p>This parameter is no longer used.</p>", "deprecated":true, - "deprecatedMessage":"Deprecated. No longer allowed." + "deprecatedMessage":"Deprecated. No longer allowed.", + "deprecatedSince":"2022-02-01" }, "Description":{ "shape":"ResourceDescription", @@ -6192,7 +6239,8 @@ "Missing", "CannotParse", "FieldValidationFailed", - "Other" + "Other", + "UnknownField" ] }, "VehicleWeightUnit":{ @@ -6283,7 +6331,7 @@ "type":"string", "max":17, "min":12, - "pattern":"([0-9A-Fa-f]{2}[:-]?){5}([0-9A-Fa-f]{2})" + "pattern":"([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})" }, "WiFiAccessPointRssInteger":{ "type":"integer", diff --git a/contrib/python/botocore/py3/botocore/data/logs/2014-03-28/service-2.json b/contrib/python/botocore/py3/botocore/data/logs/2014-03-28/service-2.json index b31f8798232..0c2b2846986 100644 --- a/contrib/python/botocore/py3/botocore/data/logs/2014-03-28/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/logs/2014-03-28/service-2.json @@ -27,7 +27,7 @@ {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"<p>Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.</p> <p>When you use <code>AssociateKmsKey</code>, you specify either the <code>logGroupName</code> parameter or the <code>resourceIdentifier</code> parameter. You can't specify both of those parameters in the same operation.</p> <ul> <li> <p>Specify the <code>logGroupName</code> parameter to cause all log events stored in the log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.</p> <p>Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.</p> <p>Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an <code>AssociateKmsKey</code> operation with the <code>resourceIdentifier</code> parameter that specifies a <code>query-result</code> resource. </p> </li> <li> <p>Specify the <code>resourceIdentifier</code> parameter with a <code>query-result</code> resource, to use that key to encrypt the stored results of all future <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html\">StartQuery</a> operations in the account. The response from a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html\">GetQueryResults</a> operation will still return the query results in plain text.</p> <p>Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.</p> <p>If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.</p> </li> </ul> <important> <p>If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.</p> </important> <note> <p>CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a>.</p> </note> <p>It can take up to 5 minutes for this operation to take effect.</p> <p>If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an <code>InvalidParameterException</code> error. </p>" + "documentation":"<p>Associates the specified KMS key with either one log group in the account, or with all stored CloudWatch Logs query insights results in the account.</p> <p>When you use <code>AssociateKmsKey</code>, you specify either the <code>logGroupName</code> parameter or the <code>resourceIdentifier</code> parameter. You can't specify both of those parameters in the same operation.</p> <ul> <li> <p>Specify the <code>logGroupName</code> parameter to cause log events ingested into that log group to be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.</p> <p>Associating a KMS key with a log group overrides any existing associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted using the KMS key. This association is stored as long as the data encrypted with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.</p> <p>Associating a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an <code>AssociateKmsKey</code> operation with the <code>resourceIdentifier</code> parameter that specifies a <code>query-result</code> resource. </p> </li> <li> <p>Specify the <code>resourceIdentifier</code> parameter with a <code>query-result</code> resource, to use that key to encrypt the stored results of all future <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html\">StartQuery</a> operations in the account. The response from a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html\">GetQueryResults</a> operation will still return the query results in plain text.</p> <p>Even if you have not associated a key with your query results, the query results are encrypted when stored, using the default CloudWatch Logs method.</p> <p>If you run a query from a monitoring account that queries logs in a source account, the query results key from the monitoring account, if any, is used.</p> </li> </ul> <important> <p>If you delete the key that is used to encrypt log events or log group query results, then all the associated stored log events or query results that were encrypted with that key will be unencryptable and unusable.</p> </important> <note> <p>CloudWatch Logs supports only symmetric KMS keys. Do not use an associate an asymmetric KMS key with your log group or query results. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using Symmetric and Asymmetric Keys</a>.</p> </note> <p>It can take up to 5 minutes for this operation to take effect.</p> <p>If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an <code>InvalidParameterException</code> error. </p>" }, "CancelExportTask":{ "name":"CancelExportTask", @@ -79,7 +79,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceAlreadyExistsException"} ], - "documentation":"<p>Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a <code>CreateExportTask</code> operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.</p> <p>Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.</p> <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. </p> <p>This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html\">DescribeExportTasks</a> to get the status of the export task. Each account can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time. To cancel an export task, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html\">CancelExportTask</a>.</p> <p>You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.</p> <note> <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.</p> </note>" + "documentation":"<p>Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket. When you perform a <code>CreateExportTask</code> operation, you must use credentials that have permission to write to the S3 bucket that you specify as the destination.</p> <p>Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.</p> <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. </p> <p>This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html\">DescribeExportTasks</a> to get the status of the export task. Each account can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time. To cancel an export task, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html\">CancelExportTask</a>.</p> <p>You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix to be used as the Amazon S3 key prefix for all exported objects.</p> <note> <p>We recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instaed recommend that you use subscriptions. For more information about subscriptions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions.html\">Real-time processing of log data with subscriptions</a>.</p> </note> <note> <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the exported log field data by using Linux utilities.</p> </note>" }, "CreateLogAnomalyDetector":{ "name":"CreateLogAnomalyDetector", @@ -174,7 +174,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Deletes s <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical <i>delivery destination</i>. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.</p>" + "documentation":"<p>Deletes a <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical <i>delivery destination</i>. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does not delete the delivery destination or the delivery source.</p>" }, "DeleteDeliveryDestination":{ "name":"DeleteDeliveryDestination", @@ -422,7 +422,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"<p>Returns a list of all CloudWatch Logs account policies in the account.</p>" + "documentation":"<p>Returns a list of all CloudWatch Logs account policies in the account.</p> <p>To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are retrieving information for.</p> <ul> <li> <p>To see data protection policies, you must have the <code>logs:GetDataProtectionPolicy</code> and <code>logs:DescribeAccountPolicies</code> permissions.</p> </li> <li> <p>To see subscription filter policies, you must have the <code>logs:DescrubeSubscriptionFilters</code> and <code>logs:DescribeAccountPolicies</code> permissions.</p> </li> <li> <p>To see transformer policies, you must have the <code>logs:GetTransformer</code> and <code>logs:DescribeAccountPolicies</code> permissions.</p> </li> <li> <p>To see field index policies, you must have the <code>logs:DescribeIndexPolicies</code> and <code>logs:DescribeAccountPolicies</code> permissions.</p> </li> </ul>" }, "DescribeConfigurationTemplates":{ "name":"DescribeConfigurationTemplates", @@ -577,7 +577,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], - "documentation":"<p>Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.</p> <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>. You must include one of these two parameters, but you can't include both. </p> <p>This operation has a limit of five transactions per second, after which transactions are throttled.</p> <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html\">CloudWatch cross-account observability</a>.</p>" + "documentation":"<p>Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.</p> <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>. You must include one of these two parameters, but you can't include both. </p> <p>This operation has a limit of 25 transactions per second, after which transactions are throttled.</p> <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html\">CloudWatch cross-account observability</a>.</p>" }, "DescribeMetricFilters":{ "name":"DescribeMetricFilters", @@ -980,7 +980,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"LimitExceededException"} ], - "documentation":"<p>Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account.</p> <p> <b>Data protection policy</b> </p> <p>A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.</p> <important> <p>Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.</p> </important> <p>If you use <code>PutAccountPolicy</code> to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.</p> <p>By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the <code>logs:Unmask</code> permission can use a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html\">GetLogEvents</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html\">FilterLogEvents</a> operation with the <code>unmask</code> parameter set to <code>true</code> to view the unmasked log events. Users with the <code>logs:Unmask</code> can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the <code>unmask</code> query command.</p> <p>For more information, including a list of types of data that can be audited and masked, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html\">Protect sensitive log data with masking</a>.</p> <p>To use the <code>PutAccountPolicy</code> operation for a data protection policy, you must be signed on with the <code>logs:PutDataProtectionPolicy</code> and <code>logs:PutAccountPolicy</code> permissions.</p> <p>The <code>PutAccountPolicy</code> operation applies to all log groups in the account. You can use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html\">PutDataProtectionPolicy</a> to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.</p> <p> <b>Subscription filter policy</b> </p> <p>A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.</p> <p>The following destinations are supported for subscription filters:</p> <ul> <li> <p>An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.</p> </li> <li> <p>An Firehose data stream in the same account as the subscription policy, for same-account delivery.</p> </li> <li> <p>A Lambda function in the same account as the subscription policy, for same-account delivery.</p> </li> <li> <p>A logical destination in a different account created with <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html\">PutDestination</a>, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.</p> </li> </ul> <p>Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in <code>PolicyName</code>. To perform a <code>PutAccountPolicy</code> subscription filter operation for any destination except a Lambda function, you must also have the <code>iam:PassRole</code> permission.</p> <p> <b>Transformer policy</b> </p> <p>Creates or updates a <i>log transformer policy</i> for your account. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contain relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters.</p> <p>You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.</p> <p>A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. For more information about the available processors to use in a transformer, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors\"> Processors that you can use</a>.</p> <p>Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.</p> <p>You can create transformers only for the log groups in the Standard log class.</p> <p>You can have one account-level transformer policy that applies to all log groups in the account. Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with the <code>selectionCriteria</code> parameter. If you have multiple account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with <code>my-log</code>, you can't have another field index policy filtered to <code>my-logpprod</code> or <code>my-logging</code>.</p> <p>You can also set up a transformer at the log-group level. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html\">PutTransformer</a>. If there is both a log-group level transformer created with <code>PutTransformer</code> and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.</p> <p> <b>Field index policy</b> </p> <p>You can use field index policies to create indexes on fields found in log events in the log group. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, user IDs, or instance IDs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html\">Create field indexes to improve query performance and reduce costs</a> </p> <p>To find the fields that are in your log group events, use the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogGroupFields.html\">GetLogGroupFields</a> operation.</p> <p>For example, suppose you have created a field index for <code>requestId</code>. Then, any CloudWatch Logs Insights query on that log group that includes <code>requestId = <i>value</i> </code> or <code>requestId in [<i>value</i>, <i>value</i>, ...]</code> will attempt to process only the log events where the indexed field matches the specified value.</p> <p>Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field of <code>RequestId</code> won't match a log event containing <code>requestId</code>.</p> <p>You can have one account-level field index policy that applies to all log groups in the account. Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups with the <code>selectionCriteria</code> parameter. If you have multiple account-level index policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with <code>my-log</code>, you can't have another field index policy filtered to <code>my-logpprod</code> or <code>my-logging</code>.</p> <p>If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only to the monitoring account and not to any source accounts.</p> <p>If you want to create a field index policy for a single log group, you can use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html\">PutIndexPolicy</a> instead of <code>PutAccountPolicy</code>. If you do so, that log group will use only that log-group level policy, and will ignore the account-level policy that you create with <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html\">PutAccountPolicy</a>.</p>" + "documentation":"<p>Creates an account-level data protection policy, subscription filter policy, or field index policy that applies to all log groups or a subset of log groups in the account.</p> <p>To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are creating.</p> <ul> <li> <p>To create a data protection policy, you must have the <code>logs:PutDataProtectionPolicy</code> and <code>logs:PutAccountPolicy</code> permissions.</p> </li> <li> <p>To create a subscription filter policy, you must have the <code>logs:PutSubscriptionFilter</code> and <code>logs:PutccountPolicy</code> permissions.</p> </li> <li> <p>To create a transformer policy, you must have the <code>logs:PutTransformer</code> and <code>logs:PutAccountPolicy</code> permissions.</p> </li> <li> <p>To create a field index policy, you must have the <code>logs:PutIndexPolicy</code> and <code>logs:PutAccountPolicy</code> permissions.</p> </li> </ul> <p> <b>Data protection policy</b> </p> <p>A data protection policy can help safeguard sensitive data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only one account-level data protection policy.</p> <important> <p>Sensitive data is detected and masked when it is ingested into a log group. When you set a data protection policy, log events ingested into the log groups before that time are not masked.</p> </important> <p>If you use <code>PutAccountPolicy</code> to create a data protection policy for your whole account, it applies to both existing log groups and all log groups that are created later in this account. The account-level policy is applied to existing log groups with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.</p> <p>By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks. A user who has the <code>logs:Unmask</code> permission can use a <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html\">GetLogEvents</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html\">FilterLogEvents</a> operation with the <code>unmask</code> parameter set to <code>true</code> to view the unmasked log events. Users with the <code>logs:Unmask</code> can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query with the <code>unmask</code> query command.</p> <p>For more information, including a list of types of data that can be audited and masked, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html\">Protect sensitive log data with masking</a>.</p> <p>To use the <code>PutAccountPolicy</code> operation for a data protection policy, you must be signed on with the <code>logs:PutDataProtectionPolicy</code> and <code>logs:PutAccountPolicy</code> permissions.</p> <p>The <code>PutAccountPolicy</code> operation applies to all log groups in the account. You can use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html\">PutDataProtectionPolicy</a> to create a data protection policy that applies to just one log group. If a log group has its own data protection policy and the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term specified in either policy is masked.</p> <p> <b>Subscription filter policy</b> </p> <p>A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to both existing log groups and log groups that are created later in this account. Supported destinations are Kinesis Data Streams, Firehose, and Lambda. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.</p> <p>The following destinations are supported for subscription filters:</p> <ul> <li> <p>An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.</p> </li> <li> <p>An Firehose data stream in the same account as the subscription policy, for same-account delivery.</p> </li> <li> <p>A Lambda function in the same account as the subscription policy, for same-account delivery.</p> </li> <li> <p>A logical destination in a different account created with <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html\">PutDestination</a>, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.</p> </li> </ul> <p>Each account can have one account-level subscription filter policy per Region. If you are updating an existing filter, you must specify the correct name in <code>PolicyName</code>. To perform a <code>PutAccountPolicy</code> subscription filter operation for any destination except a Lambda function, you must also have the <code>iam:PassRole</code> permission.</p> <p> <b>Transformer policy</b> </p> <p>Creates or updates a <i>log transformer policy</i> for your account. You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contain relevant, source-specific information. After you have created a transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters.</p> <p>You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.</p> <p>A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. For more information about the available processors to use in a transformer, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors\"> Processors that you can use</a>.</p> <p>Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.</p> <p>You can create transformers only for the log groups in the Standard log class.</p> <p>You can have one account-level transformer policy that applies to all log groups in the account. Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with the <code>selectionCriteria</code> parameter. If you have multiple account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with <code>my-log</code>, you can't have another field index policy filtered to <code>my-logpprod</code> or <code>my-logging</code>.</p> <p>You can also set up a transformer at the log-group level. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html\">PutTransformer</a>. If there is both a log-group level transformer created with <code>PutTransformer</code> and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.</p> <p> <b>Field index policy</b> </p> <p>You can use field index policies to create indexes on fields found in log events in the log group. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field. Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events. Common examples of indexes include request ID, session ID, user IDs, or instance IDs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html\">Create field indexes to improve query performance and reduce costs</a> </p> <p>To find the fields that are in your log group events, use the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogGroupFields.html\">GetLogGroupFields</a> operation.</p> <p>For example, suppose you have created a field index for <code>requestId</code>. Then, any CloudWatch Logs Insights query on that log group that includes <code>requestId = <i>value</i> </code> or <code>requestId in [<i>value</i>, <i>value</i>, ...]</code> will attempt to process only the log events where the indexed field matches the specified value.</p> <p>Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field of <code>RequestId</code> won't match a log event containing <code>requestId</code>.</p> <p>You can have one account-level field index policy that applies to all log groups in the account. Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups with the <code>selectionCriteria</code> parameter. If you have multiple account-level index policies with selection criteria, no two of them can use the same or overlapping log group name prefixes. For example, if you have one policy filtered to log groups that start with <code>my-log</code>, you can't have another field index policy filtered to <code>my-logpprod</code> or <code>my-logging</code>.</p> <p>If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only to the monitoring account and not to any source accounts.</p> <p>If you want to create a field index policy for a single log group, you can use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html\">PutIndexPolicy</a> instead of <code>PutAccountPolicy</code>. If you do so, that log group will use only that log-group level policy, and will ignore the account-level policy that you create with <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html\">PutAccountPolicy</a>.</p>" }, "PutDataProtectionPolicy":{ "name":"PutDataProtectionPolicy", @@ -1015,7 +1015,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Creates or updates a logical <i>delivery destination</i>. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.</p> <p>To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:</p> <ul> <li> <p>Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html\">PutDeliverySource</a>.</p> </li> <li> <p>Use <code>PutDeliveryDestination</code> to create a <i>delivery destination</i>, which is a logical object that represents the actual delivery destination. </p> </li> <li> <p>If you are delivering logs cross-account, you must use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html\">PutDeliveryDestinationPolicy</a> in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination. </p> </li> <li> <p>Use <code>CreateDelivery</code> to create a <i>delivery</i> by pairing exactly one delivery source and one delivery destination. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html\">CreateDelivery</a>. </p> </li> </ul> <p>You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.</p> <p>Only some Amazon Web Services services support being configured as a delivery source. These services are listed as <b>Supported [V2 Permissions]</b> in the table at <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html\">Enabling logging from Amazon Web Services services.</a> </p> <p>If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.</p>" + "documentation":"<p>Creates or updates a logical <i>delivery destination</i>. A delivery destination is an Amazon Web Services resource that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are supported as logs delivery destinations.</p> <p>To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:</p> <ul> <li> <p>Create a delivery source, which is a logical object that represents the resource that is actually sending the logs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html\">PutDeliverySource</a>.</p> </li> <li> <p>Use <code>PutDeliveryDestination</code> to create a <i>delivery destination</i> in the same account of the actual delivery destination. The delivery destination that you create is a logical object that represents the actual delivery destination. </p> </li> <li> <p>If you are delivering logs cross-account, you must use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html\">PutDeliveryDestinationPolicy</a> in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination. </p> </li> <li> <p>Use <code>CreateDelivery</code> to create a <i>delivery</i> by pairing exactly one delivery source and one delivery destination. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html\">CreateDelivery</a>. </p> </li> </ul> <p>You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.</p> <p>Only some Amazon Web Services services support being configured as a delivery source. These services are listed as <b>Supported [V2 Permissions]</b> in the table at <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html\">Enabling logging from Amazon Web Services services.</a> </p> <p>If you use this operation to update an existing delivery destination, all the current delivery destination parameters are overwritten with the new parameter values that you specify.</p>" }, "PutDeliveryDestinationPolicy":{ "name":"PutDeliveryDestinationPolicy", @@ -1146,7 +1146,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"InvalidOperationException"} ], - "documentation":"<p>Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html\">PutLogEvents</a>.</p> <p>The maximum number of metric filters that can be associated with a log group is 100.</p> <p>Using regular expressions to create metric filters is supported. For these filters, there is a quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in metric filters, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html\"> Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p> <p>When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.</p> <important> <p>Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as <code>IPAddress</code> or <code>requestID</code> as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. </p> <p>CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.</p> <p>You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html\"> Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges</a>. </p> </important>" + "documentation":"<p>Creates or updates a metric filter and associates it with the specified log group. With metric filters, you can configure rules to extract metric data from log events ingested through <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html\">PutLogEvents</a>.</p> <p>The maximum number of metric filters that can be associated with a log group is 100.</p> <p>Using regular expressions in filter patterns is supported. For these filters, there is a quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in filter patterns, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html\"> Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p> <p>When you create a metric filter, you can also optionally assign a unit and dimensions to the metric that is created.</p> <important> <p>Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as <code>IPAddress</code> or <code>requestID</code> as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. </p> <p>CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for your specified dimensions within one hour.</p> <p>You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html\"> Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges</a>. </p> </important>" }, "PutQueryDefinition":{ "name":"PutQueryDefinition", @@ -1209,7 +1209,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"InvalidOperationException"} ], - "documentation":"<p>Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html\">PutLogEvents</a> and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.</p> <p>The following destinations are supported for subscription filters:</p> <ul> <li> <p>An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>A logical destination created with <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html\">PutDestination</a> that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.</p> </li> <li> <p>An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.</p> </li> </ul> <p>Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in <code>filterName</code>. </p> <p>Using regular expressions to create subscription filters is supported. For these filters, there is a quotas of quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in subscription filters, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html\"> Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p> <p>To perform a <code>PutSubscriptionFilter</code> operation for any destination except a Lambda function, you must also have the <code>iam:PassRole</code> permission.</p>" + "documentation":"<p>Creates or updates a subscription filter and associates it with the specified log group. With subscription filters, you can subscribe to a real-time stream of log events ingested through <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html\">PutLogEvents</a> and have them delivered to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP format.</p> <p>The following destinations are supported for subscription filters:</p> <ul> <li> <p>An Amazon Kinesis data stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>A logical destination created with <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html\">PutDestination</a> that belongs to a different account, for cross-account delivery. We currently support Kinesis Data Streams and Firehose as logical destinations.</p> </li> <li> <p>An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>An Lambda function that belongs to the same account as the subscription filter, for same-account delivery.</p> </li> </ul> <p>Each log group can have up to two subscription filters associated with it. If you are updating an existing filter, you must specify the correct name in <code>filterName</code>. </p> <p>Using regular expressions in filter patterns is supported. For these filters, there is a quotas of quota of two regular expression patterns within a single filter pattern. There is also a quota of five regular expression patterns per log group. For more information about using regular expressions in filter patterns, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html\"> Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p> <p>To perform a <code>PutSubscriptionFilter</code> operation for any destination except a Lambda function, you must also have the <code>iam:PassRole</code> permission.</p>" }, "PutTransformer":{ "name":"PutTransformer", @@ -4959,11 +4959,11 @@ }, "dataSourceRoleArn":{ "shape":"Arn", - "documentation":"<p>Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see <a href=\"https://docs.aws.amazon.com/OpenSearch-Dashboards-CreateRole\">Create an IAM role to access the OpenSearch Service collection</a> in the CloudWatch Logs User Guide.</p>" + "documentation":"<p>Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-CreateRole.html\">Permissions that the integration needs</a> in the CloudWatch Logs User Guide.</p>" }, "dashboardViewerPrincipals":{ "shape":"DashboardViewerPrincipals", - "documentation":"<p>Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.</p> <important> <p>In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardsAccess</b> IAM policy. For more information, see </p> </important>" + "documentation":"<p>Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.</p> <important> <p>In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardAccess</b> IAM policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-UserRoles.html\">IAM policies for users</a>.</p> </important>" }, "applicationArn":{ "shape":"Arn", @@ -5500,7 +5500,7 @@ }, "logType":{ "shape":"LogType", - "documentation":"<p>Defines the type of log that the source is sending.</p> <ul> <li> <p>For Amazon Bedrock, the valid value is <code>APPLICATION_LOGS</code>.</p> </li> <li> <p>For Amazon CodeWhisperer, the valid value is <code>EVENT_LOGS</code>.</p> </li> <li> <p>For IAM Identity Center, the valid value is <code>ERROR_LOGS</code>.</p> </li> <li> <p>For Amazon WorkMail, the valid values are <code>ACCESS_CONTROL_LOGS</code>, <code>AUTHENTICATION_LOGS</code>, <code>WORKMAIL_AVAILABILITY_PROVIDER_LOGS</code>, and <code>WORKMAIL_MAILBOX_ACCESS_LOGS</code>.</p> </li> </ul>" + "documentation":"<p>Defines the type of log that the source is sending.</p> <ul> <li> <p>For Amazon Bedrock, the valid value is <code>APPLICATION_LOGS</code>.</p> </li> <li> <p>For CloudFront, the valid value is <code>ACCESS_LOGS</code>.</p> </li> <li> <p>For Amazon CodeWhisperer, the valid value is <code>EVENT_LOGS</code>.</p> </li> <li> <p>For Elemental MediaPackage, the valid values are <code>EGRESS_ACCESS_LOGS</code> and <code>INGRESS_ACCESS_LOGS</code>.</p> </li> <li> <p>For Elemental MediaTailor, the valid values are <code>AD_DECISION_SERVER_LOGS</code>, <code>MANIFEST_SERVICE_LOGS</code>, and <code>TRANSCODE_LOGS</code>.</p> </li> <li> <p>For IAM Identity Center, the valid value is <code>ERROR_LOGS</code>.</p> </li> <li> <p>For Amazon Q, the valid value is <code>EVENT_LOGS</code>.</p> </li> <li> <p>For Amazon SES mail manager, the valid value is <code>APPLICATION_LOG</code>.</p> </li> <li> <p>For Amazon WorkMail, the valid values are <code>ACCESS_CONTROL_LOGS</code>, <code>AUTHENTICATION_LOGS</code>, <code>WORKMAIL_AVAILABILITY_PROVIDER_LOGS</code>, <code>WORKMAIL_MAILBOX_ACCESS_LOGS</code>, and <code>WORKMAIL_PERSONAL_ACCESS_TOKEN_LOGS</code>.</p> </li> </ul>" }, "tags":{ "shape":"Tags", @@ -6222,7 +6222,7 @@ "members":{ "suffixPath":{ "shape":"DeliverySuffixPath", - "documentation":"<p>This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for more info on what values are supported in the suffix path for each log source.</p>" + "documentation":"<p>This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables to use in the suffix path will vary by each log source. To find the values supported for the suffix path for each log source, use the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeConfigurationTemplates.html\">DescribeConfigurationTemplates</a> operation and check the <code>allowedSuffixPathFields</code> field in the response.</p>" }, "enableHiveCompatiblePath":{ "shape":"Boolean", @@ -6290,7 +6290,7 @@ "members":{ "message":{"shape":"Message"} }, - "documentation":"<p>his exception is returned if an unknown error occurs during a Live Tail session.</p>", + "documentation":"<p>This exception is returned if an unknown error occurs during a Live Tail session.</p>", "exception":true }, "SessionTimeoutException":{ diff --git a/contrib/python/botocore/py3/botocore/data/mailmanager/2023-10-17/paginators-1.json b/contrib/python/botocore/py3/botocore/data/mailmanager/2023-10-17/paginators-1.json index 70309f1c2dd..a87e9682926 100644 --- a/contrib/python/botocore/py3/botocore/data/mailmanager/2023-10-17/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/mailmanager/2023-10-17/paginators-1.json @@ -53,6 +53,24 @@ "output_token": "NextToken", "limit_key": "PageSize", "result_key": "TrafficPolicies" + }, + "ListAddressListImportJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "PageSize", + "result_key": "ImportJobs" + }, + "ListAddressLists": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "PageSize", + "result_key": "AddressLists" + }, + "ListMembersOfAddressList": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "PageSize", + "result_key": "Addresses" } } } diff --git a/contrib/python/botocore/py3/botocore/data/mailmanager/2023-10-17/service-2.json b/contrib/python/botocore/py3/botocore/data/mailmanager/2023-10-17/service-2.json index f20070197b5..86bfd66f282 100644 --- a/contrib/python/botocore/py3/botocore/data/mailmanager/2023-10-17/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/mailmanager/2023-10-17/service-2.json @@ -48,6 +48,41 @@ "documentation":"<p>Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.</p>", "idempotent":true }, + "CreateAddressList":{ + "name":"CreateAddressList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAddressListRequest"}, + "output":{"shape":"CreateAddressListResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Creates a new address list.</p>", + "idempotent":true + }, + "CreateAddressListImportJob":{ + "name":"CreateAddressListImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAddressListImportJobRequest"}, + "output":{"shape":"CreateAddressListImportJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Creates an import job for an address list.</p>", + "idempotent":true + }, "CreateArchive":{ "name":"CreateArchive", "http":{ @@ -160,6 +195,22 @@ "documentation":"<p>Deletes an Add On subscription.</p>", "idempotent":true }, + "DeleteAddressList":{ + "name":"DeleteAddressList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAddressListRequest"}, + "output":{"shape":"DeleteAddressListResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Deletes an address list.</p>", + "idempotent":true + }, "DeleteArchive":{ "name":"DeleteArchive", "http":{ @@ -240,6 +291,23 @@ "documentation":"<p>Delete a traffic policy resource.</p>", "idempotent":true }, + "DeregisterMemberFromAddressList":{ + "name":"DeregisterMemberFromAddressList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterMemberFromAddressListRequest"}, + "output":{"shape":"DeregisterMemberFromAddressListResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Removes a member from an address list.</p>", + "idempotent":true + }, "GetAddonInstance":{ "name":"GetAddonInstance", "http":{ @@ -268,6 +336,38 @@ ], "documentation":"<p>Gets detailed information about an Add On subscription.</p>" }, + "GetAddressList":{ + "name":"GetAddressList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAddressListRequest"}, + "output":{"shape":"GetAddressListResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Fetch attributes of an address list.</p>" + }, + "GetAddressListImportJob":{ + "name":"GetAddressListImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAddressListImportJobRequest"}, + "output":{"shape":"GetAddressListImportJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Fetch attributes of an import job.</p>" + }, "GetArchive":{ "name":"GetArchive", "http":{ @@ -374,6 +474,22 @@ ], "documentation":"<p>Fetch ingress endpoint resource attributes.</p>" }, + "GetMemberOfAddressList":{ + "name":"GetMemberOfAddressList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMemberOfAddressListRequest"}, + "output":{"shape":"GetMemberOfAddressListResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Fetch attributes of a member in an address list.</p>" + }, "GetRelay":{ "name":"GetRelay", "http":{ @@ -442,6 +558,37 @@ ], "documentation":"<p>Lists all Add On subscriptions in your account.</p>" }, + "ListAddressListImportJobs":{ + "name":"ListAddressListImportJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAddressListImportJobsRequest"}, + "output":{"shape":"ListAddressListImportJobsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Lists jobs for an address list.</p>" + }, + "ListAddressLists":{ + "name":"ListAddressLists", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAddressListsRequest"}, + "output":{"shape":"ListAddressListsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Lists address lists for this account.</p>" + }, "ListArchiveExports":{ "name":"ListArchiveExports", "http":{ @@ -502,6 +649,22 @@ ], "documentation":"<p>List all ingress endpoint resources.</p>" }, + "ListMembersOfAddressList":{ + "name":"ListMembersOfAddressList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMembersOfAddressListRequest"}, + "output":{"shape":"ListMembersOfAddressListResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Lists members of an address list.</p>" + }, "ListRelays":{ "name":"ListRelays", "http":{ @@ -555,6 +718,43 @@ ], "documentation":"<p>List traffic policy resources.</p>" }, + "RegisterMemberToAddressList":{ + "name":"RegisterMemberToAddressList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterMemberToAddressListRequest"}, + "output":{"shape":"RegisterMemberToAddressListResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Adds a member to an address list.</p>", + "idempotent":true + }, + "StartAddressListImportJob":{ + "name":"StartAddressListImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAddressListImportJobRequest"}, + "output":{"shape":"StartAddressListImportJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Starts an import job for an address list.</p>", + "idempotent":true + }, "StartArchiveExport":{ "name":"StartArchiveExport", "http":{ @@ -590,6 +790,24 @@ ], "documentation":"<p>Initiates a search across emails in the specified archive.</p>" }, + "StopAddressListImportJob":{ + "name":"StopAddressListImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopAddressListImportJobRequest"}, + "output":{"shape":"StopAddressListImportJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Stops an ongoing import job for an address list.</p>", + "idempotent":true + }, "StopArchiveExport":{ "name":"StopArchiveExport", "http":{ @@ -850,6 +1068,84 @@ "type":"list", "member":{"shape":"AddonSubscription"} }, + "Address":{ + "type":"string", + "max":320, + "min":3, + "sensitive":true + }, + "AddressFilter":{ + "type":"structure", + "members":{ + "AddressPrefix":{ + "shape":"AddressPrefix", + "documentation":"<p>Filter to limit the results to addresses having the provided prefix.</p>" + } + }, + "documentation":"<p>Filtering options for ListMembersOfAddressList operation.</p>" + }, + "AddressList":{ + "type":"structure", + "required":[ + "AddressListArn", + "AddressListId", + "AddressListName", + "CreatedTimestamp", + "LastUpdatedTimestamp" + ], + "members":{ + "AddressListArn":{ + "shape":"AddressListArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the address list.</p>" + }, + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The identifier of the address list.</p>" + }, + "AddressListName":{ + "shape":"AddressListName", + "documentation":"<p>The user-friendly name of the address list.</p>" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The timestamp of when the address list was created.</p>" + }, + "LastUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The timestamp of when the address list was last updated.</p>" + } + }, + "documentation":"<p>An address list contains a list of emails and domains that are used in MailManager Ingress endpoints and Rules for email management.</p>" + }, + "AddressListArn":{"type":"string"}, + "AddressListId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9-]+$" + }, + "AddressListName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9_.-]+$" + }, + "AddressLists":{ + "type":"list", + "member":{"shape":"AddressList"} + }, + "AddressPageSize":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "AddressPrefix":{ + "type":"string", + "max":320, + "min":1, + "sensitive":true + }, "Analysis":{ "type":"structure", "required":[ @@ -1145,6 +1441,79 @@ } } }, + "CreateAddressListImportJobRequest":{ + "type":"structure", + "required":[ + "AddressListId", + "ImportDataFormat", + "Name" + ], + "members":{ + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The unique identifier of the address list for importing addresses to.</p>" + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"<p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>", + "idempotencyToken":true + }, + "ImportDataFormat":{ + "shape":"ImportDataFormat", + "documentation":"<p>The format of the input for an import job.</p>" + }, + "Name":{ + "shape":"JobName", + "documentation":"<p>A user-friendly name for the import job.</p>" + } + } + }, + "CreateAddressListImportJobResponse":{ + "type":"structure", + "required":[ + "JobId", + "PreSignedUrl" + ], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"<p>The identifier of the created import job.</p>" + }, + "PreSignedUrl":{ + "shape":"PreSignedUrl", + "documentation":"<p>The pre-signed URL target for uploading the input file.</p>" + } + } + }, + "CreateAddressListRequest":{ + "type":"structure", + "required":["AddressListName"], + "members":{ + "AddressListName":{ + "shape":"AddressListName", + "documentation":"<p>A user-friendly name for the address list.</p>" + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"<p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"<p>The tags used to organize, track, or control access for the resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" + } + } + }, + "CreateAddressListResponse":{ + "type":"structure", + "required":["AddressListId"], + "members":{ + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The identifier of the created address list.</p>" + } + } + }, "CreateArchiveRequest":{ "type":"structure", "required":["ArchiveName"], @@ -1391,6 +1760,21 @@ "members":{ } }, + "DeleteAddressListRequest":{ + "type":"structure", + "required":["AddressListId"], + "members":{ + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The identifier of an existing address list resource to delete.</p>" + } + } + }, + "DeleteAddressListResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteArchiveRequest":{ "type":"structure", "required":["ArchiveId"], @@ -1517,6 +1901,28 @@ }, "documentation":"<p>The action to deliver incoming emails to an Amazon Q Business application for indexing.</p>" }, + "DeregisterMemberFromAddressListRequest":{ + "type":"structure", + "required":[ + "Address", + "AddressListId" + ], + "members":{ + "Address":{ + "shape":"Address", + "documentation":"<p>The address to be removed from the address list.</p>" + }, + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The unique identifier of the address list to remove the address from.</p>" + } + } + }, + "DeregisterMemberFromAddressListResponse":{ + "type":"structure", + "members":{ + } + }, "Double":{ "type":"double", "box":true @@ -1686,6 +2092,120 @@ } } }, + "GetAddressListImportJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"<p>The identifier of the import job that needs to be retrieved.</p>" + } + } + }, + "GetAddressListImportJobResponse":{ + "type":"structure", + "required":[ + "AddressListId", + "CreatedTimestamp", + "ImportDataFormat", + "JobId", + "Name", + "PreSignedUrl", + "Status" + ], + "members":{ + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The unique identifier of the address list the import job was created for.</p>" + }, + "CompletedTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The timestamp of when the import job was completed.</p>" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The timestamp of when the import job was created.</p>" + }, + "Error":{ + "shape":"ErrorMessage", + "documentation":"<p>The reason for failure of an import job.</p>" + }, + "FailedItemsCount":{ + "shape":"JobItemsCount", + "documentation":"<p>The number of input addresses that failed to be imported into the address list.</p>" + }, + "ImportDataFormat":{ + "shape":"ImportDataFormat", + "documentation":"<p>The format of the input for an import job.</p>" + }, + "ImportedItemsCount":{ + "shape":"JobItemsCount", + "documentation":"<p>The number of input addresses successfully imported into the address list.</p>" + }, + "JobId":{ + "shape":"JobId", + "documentation":"<p>The identifier of the import job.</p>" + }, + "Name":{ + "shape":"JobName", + "documentation":"<p>A user-friendly name for the import job.</p>" + }, + "PreSignedUrl":{ + "shape":"PreSignedUrl", + "documentation":"<p>The pre-signed URL target for uploading the input file.</p>" + }, + "StartTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The timestamp of when the import job was started.</p>" + }, + "Status":{ + "shape":"ImportJobStatus", + "documentation":"<p>The status of the import job.</p>" + } + } + }, + "GetAddressListRequest":{ + "type":"structure", + "required":["AddressListId"], + "members":{ + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The identifier of an existing address list resource to be retrieved.</p>" + } + } + }, + "GetAddressListResponse":{ + "type":"structure", + "required":[ + "AddressListArn", + "AddressListId", + "AddressListName", + "CreatedTimestamp", + "LastUpdatedTimestamp" + ], + "members":{ + "AddressListArn":{ + "shape":"AddressListArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the address list resource.</p>" + }, + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The identifier of the address list resource.</p>" + }, + "AddressListName":{ + "shape":"AddressListName", + "documentation":"<p>A user-friendly name for the address list resource.</p>" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The date of when then address list was created.</p>" + }, + "LastUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The date of when the address list was last updated.</p>" + } + } + }, "GetArchiveExportRequest":{ "type":"structure", "required":["ExportId"], @@ -1962,6 +2482,40 @@ } } }, + "GetMemberOfAddressListRequest":{ + "type":"structure", + "required":[ + "Address", + "AddressListId" + ], + "members":{ + "Address":{ + "shape":"Address", + "documentation":"<p>The address to be retrieved from the address list.</p>" + }, + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The unique identifier of the address list to retrieve the address from.</p>" + } + } + }, + "GetMemberOfAddressListResponse":{ + "type":"structure", + "required":[ + "Address", + "CreatedTimestamp" + ], + "members":{ + "Address":{ + "shape":"Address", + "documentation":"<p>The address retrieved from the address list.</p>" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The timestamp of when the address was created.</p>" + } + } + }, "GetRelayRequest":{ "type":"structure", "required":["RelayId"], @@ -2136,6 +2690,111 @@ "max":128, "min":1 }, + "ImportDataFormat":{ + "type":"structure", + "required":["ImportDataType"], + "members":{ + "ImportDataType":{ + "shape":"ImportDataType", + "documentation":"<p>The type of file that would be passed as an input for the address list import job.</p>" + } + }, + "documentation":"<p>The import data format contains the specifications of the input file that would be passed to the address list import job.</p>" + }, + "ImportDataType":{ + "type":"string", + "enum":[ + "CSV", + "JSON" + ] + }, + "ImportJob":{ + "type":"structure", + "required":[ + "AddressListId", + "CreatedTimestamp", + "ImportDataFormat", + "JobId", + "Name", + "PreSignedUrl", + "Status" + ], + "members":{ + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The unique identifier of the address list the import job was created for.</p>" + }, + "CompletedTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The timestamp of when the import job was completed.</p>" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The timestamp of when the import job was created.</p>" + }, + "Error":{ + "shape":"ErrorMessage", + "documentation":"<p>The reason for failure of an import job.</p>" + }, + "FailedItemsCount":{ + "shape":"JobItemsCount", + "documentation":"<p>The number of addresses in the input that failed to get imported into address list.</p>" + }, + "ImportDataFormat":{ + "shape":"ImportDataFormat", + "documentation":"<p>The format of the input for the import job.</p>" + }, + "ImportedItemsCount":{ + "shape":"JobItemsCount", + "documentation":"<p>The number of addresses in the input that were successfully imported into the address list.</p>" + }, + "JobId":{ + "shape":"JobId", + "documentation":"<p>The identifier of the import job.</p>" + }, + "Name":{ + "shape":"JobName", + "documentation":"<p>A user-friendly name for the import job.</p>" + }, + "PreSignedUrl":{ + "shape":"PreSignedUrl", + "documentation":"<p>The pre-signed URL target for uploading the input file.</p>" + }, + "StartTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The timestamp of when the import job was started.</p>" + }, + "Status":{ + "shape":"ImportJobStatus", + "documentation":"<p>The status of the import job.</p>" + } + }, + "documentation":"<p>Details about an import job.</p>" + }, + "ImportJobStatus":{ + "type":"string", + "enum":[ + "CREATED", + "PROCESSING", + "COMPLETED", + "FAILED", + "STOPPED" + ] + }, + "ImportJobs":{ + "type":"list", + "member":{"shape":"ImportJob"} + }, + "IngressAddressListArnList":{ + "type":"list", + "member":{"shape":"AddressListArn"}, + "max":1, + "min":1 + }, + "IngressAddressListEmailAttribute":{ + "type":"string", + "enum":["RECIPIENT"] + }, "IngressAnalysis":{ "type":"structure", "required":[ @@ -2185,6 +2844,10 @@ "Analysis":{ "shape":"IngressAnalysis", "documentation":"<p>The structure type for a boolean condition stating the Add On ARN and its returned value.</p>" + }, + "IsInAddressList":{ + "shape":"IngressIsInAddressList", + "documentation":"<p>The structure type for a boolean condition that provides the address lists to evaluate incoming traffic on.</p>" } }, "documentation":"<p>The union type representing the allowed types of operands for a boolean condition.</p>", @@ -2235,6 +2898,24 @@ }, "documentation":"<p>The union type representing the allowed types for the left hand side of an IP condition.</p>" }, + "IngressIsInAddressList":{ + "type":"structure", + "required":[ + "AddressLists", + "Attribute" + ], + "members":{ + "AddressLists":{ + "shape":"IngressAddressListArnList", + "documentation":"<p>The address lists that will be used for evaluation.</p>" + }, + "Attribute":{ + "shape":"IngressAddressListEmailAttribute", + "documentation":"<p>The email attribute that needs to be evaluated against the address list.</p>" + } + }, + "documentation":"<p>The address lists and the address list attribute value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.</p>" + }, "IngressPoint":{ "type":"structure", "required":[ @@ -2468,6 +3149,22 @@ "type":"list", "member":{"shape":"Ipv4Cidr"} }, + "JobId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9-]+$" + }, + "JobItemsCount":{ + "type":"integer", + "box":true + }, + "JobName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9_.-]+$" + }, "KmsKeyArn":{ "type":"string", "pattern":"^arn:aws(|-cn|-us-gov):kms:[a-z0-9-]{1,20}:[0-9]{12}:(key|alias)/.+$" @@ -2530,6 +3227,65 @@ } } }, + "ListAddressListImportJobsRequest":{ + "type":"structure", + "required":["AddressListId"], + "members":{ + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The unique identifier of the address list for listing import jobs.</p>" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"<p>If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.</p>" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"<p>The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs.</p>" + } + } + }, + "ListAddressListImportJobsResponse":{ + "type":"structure", + "required":["ImportJobs"], + "members":{ + "ImportJobs":{ + "shape":"ImportJobs", + "documentation":"<p>The list of import jobs.</p>" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"<p>If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>" + } + } + }, + "ListAddressListsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"<p>If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.</p>" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"<p>The maximum number of address list resources that are returned per call. You can use NextToken to retrieve the next page of address lists.</p>" + } + } + }, + "ListAddressListsResponse":{ + "type":"structure", + "required":["AddressLists"], + "members":{ + "AddressLists":{ + "shape":"AddressLists", + "documentation":"<p>The list of address lists.</p>" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"<p>If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>" + } + } + }, "ListArchiveExportsRequest":{ "type":"structure", "required":["ArchiveId"], @@ -2651,6 +3407,42 @@ } } }, + "ListMembersOfAddressListRequest":{ + "type":"structure", + "required":["AddressListId"], + "members":{ + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The unique identifier of the address list to list the addresses from.</p>" + }, + "Filter":{ + "shape":"AddressFilter", + "documentation":"<p>Filter to be used to limit the results.</p>" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"<p>If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.</p>" + }, + "PageSize":{ + "shape":"AddressPageSize", + "documentation":"<p>The maximum number of address list members that are returned per call. You can use NextToken to retrieve the next page of members.</p>" + } + } + }, + "ListMembersOfAddressListResponse":{ + "type":"structure", + "required":["Addresses"], + "members":{ + "Addresses":{ + "shape":"SavedAddresses", + "documentation":"<p>The list of addresses.</p>" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"<p>If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>" + } + } + }, "ListRelaysRequest":{ "type":"structure", "members":{ @@ -2784,6 +3576,10 @@ "Metadata":{ "type":"structure", "members":{ + "ConfigurationSet":{ + "shape":"String", + "documentation":"<p>The name of the configuration set used when sent through a configuration set with archiving enabled.</p>" + }, "IngressPointId":{ "shape":"IngressPointId", "documentation":"<p>The ID of the ingress endpoint through which the email was received.</p>" @@ -2800,6 +3596,22 @@ "shape":"SenderIpAddress", "documentation":"<p>The IP address of the host from which the email was received.</p>" }, + "SendingMethod":{ + "shape":"String", + "documentation":"<p>The name of the API call used when sent through a configuration set with archiving enabled.</p>" + }, + "SendingPool":{ + "shape":"String", + "documentation":"<p>The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.</p>" + }, + "SourceArn":{ + "shape":"String", + "documentation":"<p>Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.</p>" + }, + "SourceIdentity":{ + "shape":"String", + "documentation":"<p>The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.</p>" + }, "Timestamp":{ "shape":"Timestamp", "documentation":"<p>The timestamp of when the email was received.</p>" @@ -2896,6 +3708,10 @@ "type":"list", "member":{"shape":"PolicyStatement"} }, + "PreSignedUrl":{ + "type":"string", + "sensitive":true + }, "QBusinessApplicationId":{ "type":"string", "max":36, @@ -2914,6 +3730,28 @@ "max":100, "min":1 }, + "RegisterMemberToAddressListRequest":{ + "type":"structure", + "required":[ + "Address", + "AddressListId" + ], + "members":{ + "Address":{ + "shape":"Address", + "documentation":"<p>The address to be added to the address list.</p>" + }, + "AddressListId":{ + "shape":"AddressListId", + "documentation":"<p>The unique identifier of the address list where the address should be added.</p>" + } + } + }, + "RegisterMemberToAddressListResponse":{ + "type":"structure", + "members":{ + } + }, "Relay":{ "type":"structure", "members":{ @@ -3093,7 +3931,11 @@ }, "SenderIpAddress":{ "shape":"SenderIpAddress", - "documentation":"<p>The IP address of the host from which the email was received.</p>" + "documentation":"<ul> <li> <p>Mail archived with Mail Manager: The IP address of the client that connects to the ingress endpoint.</p> </li> <li> <p>Mail sent through a configuration set with the archiving option enabled: The IP address of the client that makes the SendEmail API call.</p> </li> </ul>" + }, + "SourceArn":{ + "shape":"String", + "documentation":"<p>Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.</p>" }, "Subject":{ "shape":"String", @@ -3194,6 +4036,23 @@ "max":10, "min":1 }, + "RuleAddressListArnList":{ + "type":"list", + "member":{"shape":"AddressListArn"}, + "max":1, + "min":1 + }, + "RuleAddressListEmailAttribute":{ + "type":"string", + "enum":[ + "RECIPIENT", + "MAIL_FROM", + "SENDER", + "FROM", + "TO", + "CC" + ] + }, "RuleBooleanEmailAttribute":{ "type":"string", "enum":[ @@ -3233,6 +4092,10 @@ "Attribute":{ "shape":"RuleBooleanEmailAttribute", "documentation":"<p>The boolean type representing the allowed attribute types for an email.</p>" + }, + "IsInAddressList":{ + "shape":"RuleIsInAddressList", + "documentation":"<p>The structure representing the address lists and address list attribute that will be used in evaluation of boolean expression.</p>" } }, "documentation":"<p>The union type representing the allowed types of operands for a boolean condition.</p>", @@ -3371,6 +4234,24 @@ "max":10, "min":1 }, + "RuleIsInAddressList":{ + "type":"structure", + "required":[ + "AddressLists", + "Attribute" + ], + "members":{ + "AddressLists":{ + "shape":"RuleAddressListArnList", + "documentation":"<p>The address lists that will be used for evaluation.</p>" + }, + "Attribute":{ + "shape":"RuleAddressListEmailAttribute", + "documentation":"<p>The email attribute that needs to be evaluated against the address list.</p>" + } + }, + "documentation":"<p>The structure type for a boolean condition that provides the address lists and address list attribute to evaluate.</p>" + }, "RuleName":{ "type":"string", "max":32, @@ -3662,6 +4543,28 @@ "pattern":"^[a-zA-Z0-9!_.*'()/-]+$" }, "S3PresignedURL":{"type":"string"}, + "SavedAddress":{ + "type":"structure", + "required":[ + "Address", + "CreatedTimestamp" + ], + "members":{ + "Address":{ + "shape":"Address", + "documentation":"<p>The email or domain that constitutes the address.</p>" + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"<p>The timestamp of when the address was added to the address list.</p>" + } + }, + "documentation":"<p>An address that is a member of an address list.</p>" + }, + "SavedAddresses":{ + "type":"list", + "member":{"shape":"SavedAddress"} + }, "SearchId":{ "type":"string", "max":64, @@ -3761,6 +4664,21 @@ "pattern":"^[A-Za-z0-9!@#$%^&*()_+\\-=\\[\\]{}|.,?]+$", "sensitive":true }, + "StartAddressListImportJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"<p>The identifier of the import job that needs to be started.</p>" + } + } + }, + "StartAddressListImportJobResponse":{ + "type":"structure", + "members":{ + } + }, "StartArchiveExportRequest":{ "type":"structure", "required":[ @@ -3853,6 +4771,21 @@ }, "documentation":"<p>The response from initiating an archive search.</p>" }, + "StopAddressListImportJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"<p>The identifier of the import job that needs to be stopped.</p>" + } + } + }, + "StopAddressListImportJobResponse":{ + "type":"structure", + "members":{ + } + }, "StopArchiveExportRequest":{ "type":"structure", "required":["ExportId"], @@ -3925,8 +4858,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^[a-zA-Z0-9/_\\+=\\.:@\\-]+$", - "sensitive":true + "pattern":"^[a-zA-Z0-9/_\\+=\\.:@\\-]+$" }, "TagKeyList":{ "type":"list", @@ -3966,8 +4898,7 @@ "type":"string", "max":256, "min":0, - "pattern":"^[a-zA-Z0-9/_\\+=\\.:@\\-]*$", - "sensitive":true + "pattern":"^[a-zA-Z0-9/_\\+=\\.:@\\-]*$" }, "TaggableResourceArn":{ "type":"string", diff --git a/contrib/python/botocore/py3/botocore/data/mediaconvert/2017-08-29/service-2.json b/contrib/python/botocore/py3/botocore/data/mediaconvert/2017-08-29/service-2.json index 518a698cc43..b3acd2eeaa2 100644 --- a/contrib/python/botocore/py3/botocore/data/mediaconvert/2017-08-29/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/mediaconvert/2017-08-29/service-2.json @@ -2004,7 +2004,7 @@ "ExternalAudioFileInput": { "shape": "__stringPatternS3Https", "locationName": "externalAudioFileInput", - "documentation": "Specifies audio data from an external file source." + "documentation": "Specify the S3, HTTP, or HTTPS URL for your external audio file input." }, "HlsRenditionGroupSettings": { "shape": "HlsRenditionGroupSettings", @@ -2014,12 +2014,12 @@ "LanguageCode": { "shape": "LanguageCode", "locationName": "languageCode", - "documentation": "Selects a specific language code from within an audio source." + "documentation": "Specify the language to select from your audio input. In the MediaConvert console choose from a list of languages. In your JSON job settings choose from an ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php" }, "Offset": { "shape": "__integerMinNegative2147483648Max2147483647", "locationName": "offset", - "documentation": "Specifies a time delta in milliseconds to offset the audio from the input video." + "documentation": "Specify a time delta, in milliseconds, to offset the audio from the input video.\nTo specify no offset: Keep the default value, 0.\nTo specify an offset: Enter an integer from -2147483648 to 2147483647" }, "Pids": { "shape": "__listOf__integerMin1Max2147483647", @@ -2184,11 +2184,12 @@ }, "Av1FramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "Av1QvbrSettings": { @@ -2240,7 +2241,7 @@ "FramerateConversionAlgorithm": { "shape": "Av1FramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max2147483647", @@ -2329,11 +2330,12 @@ }, "AvcIntraFramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "AvcIntraInterlaceMode": { @@ -2376,7 +2378,7 @@ "FramerateConversionAlgorithm": { "shape": "AvcIntraFramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max1001", @@ -3015,6 +3017,15 @@ }, "documentation": "Channel mapping contains the group of fields that hold the remixing value for each channel, in dB. Specify remix values to indicate how much of the content from your input audio channel you want in your output audio channels. Each instance of the InputChannels or InputChannelsFineTune array specifies these values for one output channel. Use one instance of this array for each output channel. In the console, each array corresponds to a column in the graphical depiction of the mapping matrix. The rows of the graphical matrix correspond to input channels. Valid 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). Use InputChannels or InputChannelsFineTune to specify your remix values. Don't use both." }, + "ChromaPositionMode": { + "type": "string", + "documentation": "Specify the chroma sample positioning metadata for your H.264 or H.265 output. To have MediaConvert automatically determine chroma positioning: We recommend that you keep the default value, Auto. To specify center positioning: Choose Force center. To specify top left positioning: Choose Force top left.", + "enum": [ + "AUTO", + "FORCE_CENTER", + "FORCE_TOP_LEFT" + ] + }, "ClipLimits": { "type": "structure", "members": { @@ -3808,6 +3819,7 @@ "documentation": "Container for this output. Some containers require a container settings object. If not specified, the default object will be created.", "enum": [ "F4V", + "GIF", "ISMV", "M2TS", "M3U8", @@ -4995,6 +5007,45 @@ "NO_DISPLAY_WINDOW" ] }, + "DynamicAudioSelector": { + "type": "structure", + "members": { + "AudioDurationCorrection": { + "shape": "AudioDurationCorrection", + "locationName": "audioDurationCorrection", + "documentation": "Apply audio timing corrections to help synchronize audio and video in your output. To apply timing corrections, your input must meet the following requirements: * Container: MP4, or MOV, with an accurate time-to-sample (STTS) table. * Audio track: AAC. Choose from the following audio timing correction settings: * Disabled (Default): Apply no correction. * Auto: Recommended for most inputs. MediaConvert analyzes the audio timing in your input and determines which correction setting to use, if needed. * Track: Adjust the duration of each audio frame by a constant amount to align the audio track length with STTS duration. Track-level correction does not affect pitch, and is recommended for tonal audio content such as music. * Frame: Adjust the duration of each audio frame by a variable amount to align audio frames with STTS timestamps. No corrections are made to already-aligned frames. Frame-level correction may affect the pitch of corrected frames, and is recommended for atonal audio content such as speech or percussion. * Force: Apply audio duration correction, either Track or Frame depending on your input, regardless of the accuracy of your input's STTS table. Your output audio and video may not be aligned or it may contain audio artifacts." + }, + "ExternalAudioFileInput": { + "shape": "__stringPatternS3Https", + "locationName": "externalAudioFileInput", + "documentation": "Specify the S3, HTTP, or HTTPS URL for your external audio file input." + }, + "LanguageCode": { + "shape": "LanguageCode", + "locationName": "languageCode", + "documentation": "Specify the language to select from your audio input. In the MediaConvert console choose from a list of languages. In your JSON job settings choose from an ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php" + }, + "Offset": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "offset", + "documentation": "Specify a time delta, in milliseconds, to offset the audio from the input video.\nTo specify no offset: Keep the default value, 0.\nTo specify an offset: Enter an integer from -2147483648 to 2147483647" + }, + "SelectorType": { + "shape": "DynamicAudioSelectorType", + "locationName": "selectorType", + "documentation": "Specify which audio tracks to dynamically select from your source. To select all audio tracks: Keep the default value, All tracks. To select all audio tracks with a specific language code: Choose Language code. When you do, you must also specify a language code under the Language code setting. If there is no matching Language code in your source, then no track will be selected." + } + }, + "documentation": "Use Dynamic audio selectors when you do not know the track layout of your source when you submit your job, but want to select multiple audio tracks. When you include an audio track in your output and specify this Dynamic audio selector as the Audio source, MediaConvert creates an output audio track for each dynamically selected track. Note that when you include a Dynamic audio selector for two or more inputs, each input must have the same number of audio tracks and audio channels." + }, + "DynamicAudioSelectorType": { + "type": "string", + "documentation": "Specify which audio tracks to dynamically select from your source. To select all audio tracks: Keep the default value, All tracks. To select all audio tracks with a specific language code: Choose Language code. When you do, you must also specify a language code under the Language code setting. If there is no matching Language code in your source, then no track will be selected.", + "enum": [ + "ALL_TRACKS", + "LANGUAGE_CODE" + ] + }, "Eac3AtmosBitstreamMode": { "type": "string", "documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).", @@ -5870,6 +5921,48 @@ } } }, + "GifFramerateControl": { + "type": "string", + "documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate 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 frame rate 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 frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "GifFramerateConversionAlgorithm": { + "type": "string", + "documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use Drop duplicate (DUPLICATE_DROP) conversion. When you choose Interpolate (INTERPOLATE) instead, the conversion produces smoother motion.", + "enum": [ + "DUPLICATE_DROP", + "INTERPOLATE" + ] + }, + "GifSettings": { + "type": "structure", + "members": { + "FramerateControl": { + "shape": "GifFramerateControl", + "locationName": "framerateControl", + "documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate 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 frame rate 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 frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator." + }, + "FramerateConversionAlgorithm": { + "shape": "GifFramerateConversionAlgorithm", + "locationName": "framerateConversionAlgorithm", + "documentation": "Optional. Specify how the transcoder performs framerate conversion. The default behavior is to use Drop duplicate (DUPLICATE_DROP) conversion. When you choose Interpolate (INTERPOLATE) instead, the conversion produces smoother motion." + }, + "FramerateDenominator": { + "shape": "__integerMin1Max2147483647", + "locationName": "framerateDenominator", + "documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate 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 frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976." + }, + "FramerateNumerator": { + "shape": "__integerMin1Max2147483647", + "locationName": "framerateNumerator", + "documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate 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. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976." + } + }, + "documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value GIF" + }, "H264AdaptiveQuantization": { "type": "string", "documentation": "Keep the default value, Auto, for this setting to have MediaConvert automatically apply the best types of quantization for your video content. When you want to apply your quantization settings manually, you must set H264AdaptiveQuantization to a value other than Auto. Use this setting to specify the strength of any adaptive quantization filters that you enable. If you don't want MediaConvert to do any adaptive quantization in this transcode, set Adaptive quantization to Off. Related settings: The value that you choose here applies to the following settings: H264FlickerAdaptiveQuantization, H264SpatialAdaptiveQuantization, and H264TemporalAdaptiveQuantization.", @@ -5969,11 +6062,12 @@ }, "H264FramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "H264GopBReference": { @@ -6145,7 +6239,7 @@ "FramerateConversionAlgorithm": { "shape": "H264FramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max2147483647", @@ -6427,6 +6521,14 @@ "MAIN_422_10BIT_HIGH" ] }, + "H265Deblocking": { + "type": "string", + "documentation": "Use Deblocking to improve the video quality of your output by smoothing the edges of macroblock artifacts created during video compression. To reduce blocking artifacts at block boundaries, and improve overall video quality: Keep the default value, Enabled. To not apply any deblocking: Choose Disabled. Visible block edge artifacts might appear in the output, especially at lower bitrates.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, "H265DynamicSubGop": { "type": "string", "documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames.", @@ -6461,11 +6563,12 @@ }, "H265FramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "H265GopBReference": { @@ -6602,6 +6705,11 @@ "locationName": "codecProfile", "documentation": "Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so \"Main/High\" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License." }, + "Deblocking": { + "shape": "H265Deblocking", + "locationName": "deblocking", + "documentation": "Use Deblocking to improve the video quality of your output by smoothing the edges of macroblock artifacts created during video compression. To reduce blocking artifacts at block boundaries, and improve overall video quality: Keep the default value, Enabled. To not apply any deblocking: Choose Disabled. Visible block edge artifacts might appear in the output, especially at lower bitrates." + }, "DynamicSubGop": { "shape": "H265DynamicSubGop", "locationName": "dynamicSubGop", @@ -6625,7 +6733,7 @@ "FramerateConversionAlgorithm": { "shape": "H265FramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max2147483647", @@ -7652,6 +7760,11 @@ "locationName": "dolbyVisionMetadataXml", "documentation": "Use this setting only when your video source has Dolby Vision studio mastering metadata that is carried in a separate XML file. Specify the Amazon S3 location for the metadata XML file. MediaConvert uses this file to provide global and frame-level metadata for Dolby Vision preprocessing. When you specify a file here and your input also has interleaved global and frame level metadata, MediaConvert ignores the interleaved metadata and uses only the the metadata from this external XML file. Note that your IAM service role must grant MediaConvert read permissions to this file. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html." }, + "DynamicAudioSelectors": { + "shape": "__mapOfDynamicAudioSelector", + "locationName": "dynamicAudioSelectors", + "documentation": "Use Dynamic audio selectors when you do not know the track layout of your source when you submit your job, but want to select multiple audio tracks. When you include an audio track in your output and specify this Dynamic audio selector as the Audio source, MediaConvert creates an output audio track for each dynamically selected track. Note that when you include a Dynamic audio selector for two or more inputs, each input must have the same number of audio tracks and audio channels." + }, "FileInput": { "shape": "__stringMax2048PatternS3Https", "locationName": "fileInput", @@ -7889,6 +8002,11 @@ "locationName": "dolbyVisionMetadataXml", "documentation": "Use this setting only when your video source has Dolby Vision studio mastering metadata that is carried in a separate XML file. Specify the Amazon S3 location for the metadata XML file. MediaConvert uses this file to provide global and frame-level metadata for Dolby Vision preprocessing. When you specify a file here and your input also has interleaved global and frame level metadata, MediaConvert ignores the interleaved metadata and uses only the the metadata from this external XML file. Note that your IAM service role must grant MediaConvert read permissions to this file. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html." }, + "DynamicAudioSelectors": { + "shape": "__mapOfDynamicAudioSelector", + "locationName": "dynamicAudioSelectors", + "documentation": "Use Dynamic audio selectors when you do not know the track layout of your source when you submit your job, but want to select multiple audio tracks. When you include an audio track in your output and specify this Dynamic audio selector as the Audio source, MediaConvert creates an output audio track for each dynamically selected track. Note that when you include a Dynamic audio selector for two or more inputs, each input must have the same number of audio tracks and audio channels." + }, "FilterEnable": { "shape": "InputFilterEnable", "locationName": "filterEnable", @@ -10036,11 +10154,12 @@ }, "Mpeg2FramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "Mpeg2GopSizeUnits": { @@ -10149,7 +10268,7 @@ "FramerateConversionAlgorithm": { "shape": "Mpeg2FramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max1001", @@ -10799,7 +10918,7 @@ "Extension": { "shape": "__stringMax256", "locationName": "extension", - "documentation": "Use 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 * WebM container, webm * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)" + "documentation": "Use 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 * WebM container, webm * Animated GIF container, gif * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)" }, "NameModifier": { "shape": "__stringMin1Max256", @@ -11156,11 +11275,12 @@ }, "ProresFramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "ProresInterlaceMode": { @@ -11211,7 +11331,7 @@ "FramerateConversionAlgorithm": { "shape": "ProresFramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max2147483647", @@ -12205,11 +12325,12 @@ }, "UncompressedFramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "UncompressedInterlaceMode": { @@ -12244,7 +12365,7 @@ "FramerateConversionAlgorithm": { "shape": "UncompressedFramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max2147483647", @@ -12485,11 +12606,12 @@ }, "Vc3FramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "Vc3InterlaceMode": { @@ -12519,7 +12641,7 @@ "FramerateConversionAlgorithm": { "shape": "Vc3FramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max1001", @@ -12590,6 +12712,7 @@ "AV1", "AVC_INTRA", "FRAME_CAPTURE", + "GIF", "H_264", "H_265", "MPEG2", @@ -12625,6 +12748,11 @@ "locationName": "frameCaptureSettings", "documentation": "Required when you set Codec to the value FRAME_CAPTURE." }, + "GifSettings": { + "shape": "GifSettings", + "locationName": "gifSettings", + "documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value GIF" + }, "H264Settings": { "shape": "H264Settings", "locationName": "h264Settings", @@ -12671,7 +12799,7 @@ "documentation": "Required when you set Codec to the value XAVC." } }, - "documentation": "Video codec settings contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec. For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * UNCOMPRESSED, UncompressedSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings" + "documentation": "Video codec settings contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec. For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * GIF, GifSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * UNCOMPRESSED, UncompressedSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings" }, "VideoDescription": { "type": "structure", @@ -12686,10 +12814,15 @@ "locationName": "antiAlias", "documentation": "The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting." }, + "ChromaPositionMode": { + "shape": "ChromaPositionMode", + "locationName": "chromaPositionMode", + "documentation": "Specify the chroma sample positioning metadata for your H.264 or H.265 output. To have MediaConvert automatically determine chroma positioning: We recommend that you keep the default value, Auto. To specify center positioning: Choose Force center. To specify top left positioning: Choose Force top left." + }, "CodecSettings": { "shape": "VideoCodecSettings", "locationName": "codecSettings", - "documentation": "Video codec settings contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec. For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * UNCOMPRESSED, UncompressedSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings" + "documentation": "Video codec settings contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec. For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings * FRAME_CAPTURE, FrameCaptureSettings * GIF, GifSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * UNCOMPRESSED, UncompressedSettings * VC3, Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings" }, "ColorMetadata": { "shape": "ColorMetadata", @@ -13067,11 +13200,12 @@ }, "Vp8FramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "Vp8ParControl": { @@ -13113,7 +13247,7 @@ "FramerateConversionAlgorithm": { "shape": "Vp8FramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max2147483647", @@ -13178,11 +13312,12 @@ }, "Vp9FramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "Vp9ParControl": { @@ -13224,7 +13359,7 @@ "FramerateConversionAlgorithm": { "shape": "Vp9FramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max2147483647", @@ -13312,10 +13447,11 @@ }, "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.", + "documentation": "Specify the file format for your wave audio output. To use a RIFF wave format: Keep the default value, RIFF. If your output audio is likely to exceed 4GB in file size, or if you otherwise need the extended support of the RF64 format: Choose RF64. If your player only supports the extensible wave format: Choose Extensible.", "enum": [ "RIFF", - "RF64" + "RF64", + "EXTENSIBLE" ] }, "WavSettings": { @@ -13334,7 +13470,7 @@ "Format": { "shape": "WavFormat", "locationName": "format", - "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." + "documentation": "Specify the file format for your wave audio output. To use a RIFF wave format: Keep the default value, RIFF. If your output audio is likely to exceed 4GB in file size, or if you otherwise need the extended support of the RF64 format: Choose RF64. If your player only supports the extensible wave format: Choose Extensible." }, "SampleRate": { "shape": "__integerMin8000Max192000", @@ -13363,7 +13499,7 @@ "StylePassthrough": { "shape": "WebvttStylePassthrough", "locationName": "stylePassthrough", - "documentation": "To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. MediaConvert uses default settings when style and position information is missing from your input captions. To recreate the input captions exactly: Set Style passthrough to Strict. MediaConvert automatically applies timing adjustments, including adjustments for frame rate conversion, ad avails, and input clipping. Your input captions format must be WebVTT. To ignore the style and position information from your input captions and use simplified output captions: Set Style passthrough to Disabled, or leave blank." + "documentation": "Specify how MediaConvert writes style information in your output WebVTT captions. To use the available style, color, and position information from your input captions: Choose Enabled. MediaConvert uses default settings when style and position information is missing from your input captions. To recreate the input captions exactly: Choose Strict. MediaConvert automatically applies timing adjustments, including adjustments for frame rate conversion, ad avails, and input clipping. Your input captions format must be WebVTT. To ignore the style and position information from your input captions and use simplified output captions: Keep the default value, Disabled. Or leave blank. To use the available style, color, and position information from your input captions, while merging cues with identical time ranges: Choose merge. This setting can help prevent positioning overlaps for certain players that expect a single single cue for any given time range." } }, "documentation": "Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html." @@ -13391,11 +13527,12 @@ }, "WebvttStylePassthrough": { "type": "string", - "documentation": "To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. MediaConvert uses default settings when style and position information is missing from your input captions. To recreate the input captions exactly: Set Style passthrough to Strict. MediaConvert automatically applies timing adjustments, including adjustments for frame rate conversion, ad avails, and input clipping. Your input captions format must be WebVTT. To ignore the style and position information from your input captions and use simplified output captions: Set Style passthrough to Disabled, or leave blank.", + "documentation": "Specify how MediaConvert writes style information in your output WebVTT captions. To use the available style, color, and position information from your input captions: Choose Enabled. MediaConvert uses default settings when style and position information is missing from your input captions. To recreate the input captions exactly: Choose Strict. MediaConvert automatically applies timing adjustments, including adjustments for frame rate conversion, ad avails, and input clipping. Your input captions format must be WebVTT. To ignore the style and position information from your input captions and use simplified output captions: Keep the default value, Disabled. Or leave blank. To use the available style, color, and position information from your input captions, while merging cues with identical time ranges: Choose merge. This setting can help prevent positioning overlaps for certain players that expect a single single cue for any given time range.", "enum": [ "ENABLED", "DISABLED", - "STRICT" + "STRICT", + "MERGE" ] }, "Xavc4kIntraCbgProfileClass": { @@ -13550,11 +13687,12 @@ }, "XavcFramerateConversionAlgorithm": { "type": "string", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96.", + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates.", "enum": [ "DUPLICATE_DROP", "INTERPOLATE", - "FRAMEFORMER" + "FRAMEFORMER", + "MAINTAIN_FRAME_COUNT" ] }, "XavcGopBReference": { @@ -13705,7 +13843,7 @@ "FramerateConversionAlgorithm": { "shape": "XavcFramerateConversionAlgorithm", "locationName": "framerateConversionAlgorithm", - "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96." + "documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing your video's frame rate. For numerically simple conversions, such as 60 fps to 30 fps: We recommend that you keep the default value, Drop duplicate. For numerically complex conversions, to avoid stutter: Choose Interpolate. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence: Choose FrameFormer to do motion-compensated interpolation. FrameFormer uses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost. When you choose FrameFormer, your input video resolution must be at least 128x96. To create an output with the same number of frames as your input: Choose Maintain frame count. When you do, MediaConvert will not drop, interpolate, add, or otherwise change the frame count from your input to your output. Note that since the frame count is maintained, the duration of your output will become shorter at higher frame rates and longer at lower frame rates." }, "FramerateDenominator": { "shape": "__integerMin1Max1001", @@ -14644,6 +14782,15 @@ "shape": "CaptionSelector" } }, + "__mapOfDynamicAudioSelector": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "DynamicAudioSelector" + } + }, "__mapOf__string": { "type": "map", "key": { diff --git a/contrib/python/botocore/py3/botocore/data/medialive/2017-10-14/service-2.json b/contrib/python/botocore/py3/botocore/data/medialive/2017-10-14/service-2.json index 6d768f3cfda..35cf59ada54 100644 --- a/contrib/python/botocore/py3/botocore/data/medialive/2017-10-14/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/medialive/2017-10-14/service-2.json @@ -16858,6 +16858,16 @@ "shape": "StaticImageOutputDeactivateScheduleActionSettings", "locationName": "staticImageOutputDeactivateSettings", "documentation": "Action to deactivate a static image overlay in one or more specified outputs" + }, + "Id3SegmentTaggingSettings": { + "shape": "Id3SegmentTaggingScheduleActionSettings", + "locationName": "id3SegmentTaggingSettings", + "documentation": "Action to insert ID3 metadata in every segment, in applicable output groups" + }, + "TimedMetadataSettings": { + "shape": "TimedMetadataScheduleActionSettings", + "locationName": "timedMetadataSettings", + "documentation": "Action to insert ID3 metadata once, in applicable output groups" } }, "documentation": "Holds the settings for a single schedule action." @@ -20760,6 +20770,16 @@ "shape": "__stringMax100", "locationName": "scte35NameModifier", "documentation": "Change the modifier that MediaLive automatically adds to the Streams() name for a SCTE 35 track. The default is \"scte\", which means the default name will be Streams(scte.cmfm). Any string you enter here will replace the \"scte\" string.\\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters." + }, + "Id3Behavior": { + "shape": "CmafId3Behavior", + "locationName": "id3Behavior", + "documentation": "Set to ENABLED to enable ID3 metadata insertion. To include metadata, you configure other parameters in the output group, or you add an ID3 action to the channel schedule." + }, + "Id3NameModifier": { + "shape": "__stringMax100", + "locationName": "id3NameModifier", + "documentation": "Change the modifier that MediaLive automatically adds to the Streams() name that identifies an ID3 track. The default is \"id3\", which means the default name will be Streams(id3.cmfm). Any string you enter here will replace the \"id3\" string.\\nThe modifier can only contain: numbers, letters, plus (+), minus (-), underscore (_) and period (.) and has a maximum length of 100 characters." } }, "documentation": "Cmaf Ingest Group Settings", @@ -21055,7 +21075,8 @@ "MEDIAPACKAGE_CHANNEL", "MEDIAPACKAGE_ORIGIN_ENDPOINT", "MEDIACONNECT_FLOW", - "S3_BUCKET" + "S3_BUCKET", + "MEDIATAILOR_PLAYBACK_CONFIGURATION" ] }, "CloudWatchAlarmTemplateTreatMissingData": { @@ -21095,6 +21116,12 @@ "Tags": { "shape": "TagMap", "locationName": "tags" + }, + "RequestId": { + "shape": "__stringMin1Max256PatternS", + "locationName": "requestId", + "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "idempotencyToken": true } }, "required": [ @@ -21118,6 +21145,12 @@ "Tags": { "shape": "TagMap", "locationName": "tags" + }, + "RequestId": { + "shape": "__stringMin1Max256PatternS", + "locationName": "requestId", + "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "idempotencyToken": true } }, "required": [ @@ -21269,6 +21302,12 @@ "TreatMissingData": { "shape": "CloudWatchAlarmTemplateTreatMissingData", "locationName": "treatMissingData" + }, + "RequestId": { + "shape": "__stringMin1Max256PatternS", + "locationName": "requestId", + "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "idempotencyToken": true } }, "required": [ @@ -21347,6 +21386,12 @@ "TreatMissingData": { "shape": "CloudWatchAlarmTemplateTreatMissingData", "locationName": "treatMissingData" + }, + "RequestId": { + "shape": "__stringMin1Max256PatternS", + "locationName": "requestId", + "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "idempotencyToken": true } }, "required": [ @@ -21562,6 +21607,12 @@ "Tags": { "shape": "TagMap", "locationName": "tags" + }, + "RequestId": { + "shape": "__stringMin1Max256PatternS", + "locationName": "requestId", + "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "idempotencyToken": true } }, "required": [ @@ -21585,6 +21636,12 @@ "Tags": { "shape": "TagMap", "locationName": "tags" + }, + "RequestId": { + "shape": "__stringMin1Max256PatternS", + "locationName": "requestId", + "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "idempotencyToken": true } }, "required": [ @@ -21703,6 +21760,12 @@ "Tags": { "shape": "TagMap", "locationName": "tags" + }, + "RequestId": { + "shape": "__stringMin1Max256PatternS", + "locationName": "requestId", + "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "idempotencyToken": true } }, "required": [ @@ -21741,6 +21804,12 @@ "Tags": { "shape": "TagMap", "locationName": "tags" + }, + "RequestId": { + "shape": "__stringMin1Max256PatternS", + "locationName": "requestId", + "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "idempotencyToken": true } }, "required": [ @@ -21889,6 +21958,12 @@ "Tags": { "shape": "TagMap", "locationName": "tags" + }, + "RequestId": { + "shape": "__stringMin1Max256PatternS", + "locationName": "requestId", + "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "idempotencyToken": true } }, "required": [ @@ -21926,6 +22001,12 @@ "Tags": { "shape": "TagMap", "locationName": "tags" + }, + "RequestId": { + "shape": "__stringMin1Max256PatternS", + "locationName": "requestId", + "documentation": "An ID that you assign to a create request. This ID ensures idempotency when creating resources.", + "idempotencyToken": true } }, "required": [ @@ -25596,7 +25677,7 @@ "Nodes": { "shape": "__listOf__string", "locationName": "nodes", - "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup." + "documentation": "An array with one item, which is the single Node that is associated with the ChannelPlacementGroup." }, "State": { "shape": "ChannelPlacementGroupState", @@ -25973,7 +26054,7 @@ "Nodes": { "shape": "__listOf__string", "locationName": "nodes", - "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup." + "documentation": "An array with one item, which is the single Node that is associated with the ChannelPlacementGroup." }, "State": { "shape": "ChannelPlacementGroupState", @@ -26245,7 +26326,7 @@ "Nodes": { "shape": "__listOf__string", "locationName": "nodes", - "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup." + "documentation": "An array with one item, which is the single Node that is associated with the ChannelPlacementGroup." }, "State": { "shape": "ChannelPlacementGroupState", @@ -26286,7 +26367,7 @@ "Nodes": { "shape": "__listOf__string", "locationName": "nodes", - "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup." + "documentation": "An array with one item, which is the single Node that is associated with the ChannelPlacementGroup." }, "State": { "shape": "ChannelPlacementGroupState", @@ -26327,7 +26408,7 @@ "Nodes": { "shape": "__listOf__string", "locationName": "nodes", - "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup." + "documentation": "An array with one item, which is the single Node that is associated with the ChannelPlacementGroup." }, "State": { "shape": "ChannelPlacementGroupState", @@ -27554,7 +27635,7 @@ "Nodes": { "shape": "__listOf__string", "locationName": "nodes", - "documentation": "An array with one item, which is the signle Node that is associated with the ChannelPlacementGroup." + "documentation": "An array with one item, which is the single Node that is associated with the ChannelPlacementGroup." }, "State": { "shape": "ChannelPlacementGroupState", @@ -28319,6 +28400,51 @@ "shape": "ChannelEngineVersionResponse" }, "documentation": "Placeholder documentation for __listOfChannelEngineVersionResponse" + }, + "CmafId3Behavior": { + "type": "string", + "documentation": "Cmaf Id3 Behavior", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "Id3SegmentTaggingScheduleActionSettings": { + "type": "structure", + "members": { + "Id3": { + "shape": "__string", + "locationName": "id3", + "documentation": "Complete this parameter if you want to specify the entire ID3 metadata. Enter a base64 string that contains one or more fully formed ID3 tags, according to the ID3 specification: http://id3.org/id3v2.4.0-structure" + }, + "Tag": { + "shape": "__string", + "locationName": "tag", + "documentation": "Complete this parameter if you want to specify only the metadata, not the entire frame. MediaLive will insert the metadata in a TXXX frame. Enter the value as plain text. You can include standard MediaLive variable data such as the current segment number." + } + }, + "documentation": "Settings for the action to insert ID3 metadata in every segment, in applicable output groups." + }, + "TimedMetadataScheduleActionSettings": { + "type": "structure", + "members": { + "Id3": { + "shape": "__string", + "locationName": "id3", + "documentation": "Enter a base64 string that contains one or more fully formed ID3 tags.See the ID3 specification: http://id3.org/id3v2.4.0-structure" + } + }, + "documentation": "Settings for the action to insert ID3 metadata (as a one-time action) in applicable output groups.", + "required": [ + "Id3" + ] + }, + "__stringMin1Max256PatternS": { + "type": "string", + "min": 1, + "max": 256, + "pattern": "^[\\S]+$", + "documentation": "Placeholder documentation for __stringMin1Max256PatternS" } }, "documentation": "API for AWS Elemental MediaLive" diff --git a/contrib/python/botocore/py3/botocore/data/mediatailor/2018-04-23/service-2.json b/contrib/python/botocore/py3/botocore/data/mediatailor/2018-04-23/service-2.json index 4f3850ec881..ba2350b7a31 100644 --- a/contrib/python/botocore/py3/botocore/data/mediatailor/2018-04-23/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/mediatailor/2018-04-23/service-2.json @@ -2,9 +2,10 @@ "version":"2.0", "metadata":{ "apiVersion":"2018-04-23", + "auth":["aws.auth#sigv4"], "endpointPrefix":"api.mediatailor", - "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceAbbreviation":"MediaTailor", "serviceFullName":"AWS MediaTailor", "serviceId":"MediaTailor", @@ -33,7 +34,7 @@ }, "input":{"shape":"ConfigureLogsForPlaybackConfigurationRequest"}, "output":{"shape":"ConfigureLogsForPlaybackConfigurationResponse"}, - "documentation":"<p>Amazon CloudWatch log settings for a playback configuration.</p>", + "documentation":"<p>Defines where AWS Elemental MediaTailor sends logs for the playback configuration.</p>", "idempotent":true }, "CreateChannel":{ @@ -557,10 +558,6 @@ "type":"structure", "required":["OffsetMillis"], "members":{ - "AdBreakMetadata":{ - "shape":"AdBreakMetadataList", - "documentation":"<p>Defines a list of key/value pairs that MediaTailor generates within the <code>EXT-X-ASSET</code>tag for <code>SCTE35_ENHANCED</code> output.</p>" - }, "MessageType":{ "shape":"MessageType", "documentation":"<p>The SCTE-35 ad insertion type. Accepted value: <code>SPLICE_INSERT</code>, <code>TIME_SIGNAL</code>.</p>" @@ -580,6 +577,10 @@ "TimeSignalMessage":{ "shape":"TimeSignalMessage", "documentation":"<p>Defines the SCTE-35 <code>time_signal</code> message inserted around the ad.</p> <p>Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a <code>splice_insert</code> SCTE-35 message to the ad break. This message provides basic metadata about the ad break.</p> <p>See section 9.7.4 of the 2022 SCTE-35 specification for more information.</p>" + }, + "AdBreakMetadata":{ + "shape":"AdBreakMetadataList", + "documentation":"<p>Defines a list of key/value pairs that MediaTailor generates within the <code>EXT-X-ASSET</code>tag for <code>SCTE35_ENHANCED</code> output.</p>" } }, "documentation":"<p>Ad break configuration parameters.</p>" @@ -604,6 +605,17 @@ }, "documentation":"<p>A location at which a zero-duration ad marker was detected in a VOD source manifest.</p>" }, + "AdConditioningConfiguration":{ + "type":"structure", + "required":["StreamingMediaFileConditioning"], + "members":{ + "StreamingMediaFileConditioning":{ + "shape":"StreamingMediaFileConditioning", + "documentation":"<p>For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS. <code>TRANSCODE</code> indicates that MediaTailor must transcode the ads. <code>NONE</code> indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow. For more information about ad conditioning see <a href=\"https://docs.aws.amazon.com/precondition-ads.html\">https://docs.aws.amazon.com/precondition-ads.html</a>.</p>" + } + }, + "documentation":"<p>The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns.</p>" + }, "AdMarkerPassthrough":{ "type":"structure", "members":{ @@ -639,10 +651,6 @@ "shape":"__string", "documentation":"<p>If an alert is generated for a resource, an explanation of the reason for the alert.</p>" }, - "Category":{ - "shape":"AlertCategory", - "documentation":"<p>The category that MediaTailor assigns to the alert.</p>" - }, "LastModifiedTime":{ "shape":"__timestampUnix", "documentation":"<p>The timestamp when the alert was last modified.</p>" @@ -654,6 +662,10 @@ "ResourceArn":{ "shape":"__string", "documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>" + }, + "Category":{ + "shape":"AlertCategory", + "documentation":"<p>The category that MediaTailor assigns to the alert.</p>" } }, "documentation":"<p>Alert configuration parameters.</p>" @@ -669,30 +681,30 @@ "AlternateMedia":{ "type":"structure", "members":{ - "AdBreaks":{ - "shape":"__listOfAdBreak", - "documentation":"<p>Ad break configuration parameters defined in AlternateMedia.</p>" - }, - "ClipRange":{"shape":"ClipRange"}, - "DurationMillis":{ - "shape":"__long", - "documentation":"<p>The duration of the alternateMedia in milliseconds.</p>" + "SourceLocationName":{ + "shape":"__string", + "documentation":"<p>The name of the source location for alternateMedia.</p>" }, "LiveSourceName":{ "shape":"__string", "documentation":"<p>The name of the live source for alternateMedia.</p>" }, + "VodSourceName":{ + "shape":"__string", + "documentation":"<p>The name of the VOD source for alternateMedia.</p>" + }, + "ClipRange":{"shape":"ClipRange"}, "ScheduledStartTimeMillis":{ "shape":"__long", "documentation":"<p>The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.</p>" }, - "SourceLocationName":{ - "shape":"__string", - "documentation":"<p>The name of the source location for alternateMedia.</p>" + "AdBreaks":{ + "shape":"__listOfAdBreak", + "documentation":"<p>Ad break configuration parameters defined in AlternateMedia.</p>" }, - "VodSourceName":{ - "shape":"__string", - "documentation":"<p>The name of the VOD source for alternateMedia.</p>" + "DurationMillis":{ + "shape":"__long", + "documentation":"<p>The duration of the alternateMedia in milliseconds.</p>" } }, "documentation":"<p>A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.</p>" @@ -700,13 +712,13 @@ "AudienceMedia":{ "type":"structure", "members":{ - "AlternateMedia":{ - "shape":"__listOfAlternateMedia", - "documentation":"<p>The list of AlternateMedia defined in AudienceMedia.</p>" - }, "Audience":{ "shape":"__string", "documentation":"<p>The Audience defined in AudienceMedia.</p>" + }, + "AlternateMedia":{ + "shape":"__listOfAlternateMedia", + "documentation":"<p>The list of AlternateMedia defined in AudienceMedia.</p>" } }, "documentation":"<p>An AudienceMedia object contains an Audience and a list of AlternateMedia.</p>" @@ -736,10 +748,6 @@ "AvailSuppression":{ "type":"structure", "members":{ - "FillPolicy":{ - "shape":"FillPolicy", - "documentation":"<p>Defines the policy to apply to the avail suppression mode. <code>BEHIND_LIVE_EDGE</code> will always use the full avail suppression policy. <code>AFTER_LIVE_EDGE</code> mode can be used to invoke partial ad break fills when a session starts mid-break.</p>" - }, "Mode":{ "shape":"Mode", "documentation":"<p>Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to <code>BEHIND_LIVE_EDGE</code>, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to <code>AFTER_LIVE_EDGE</code>, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.</p>" @@ -747,6 +755,10 @@ "Value":{ "shape":"__string", "documentation":"<p>A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.</p>" + }, + "FillPolicy":{ + "shape":"FillPolicy", + "documentation":"<p>Defines the policy to apply to the avail suppression mode. <code>BEHIND_LIVE_EDGE</code> will always use the full avail suppression policy. <code>AFTER_LIVE_EDGE</code> mode can be used to invoke partial ad break fills when a session starts mid-break.</p>" } }, "documentation":"<p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html\">Ad Suppression</a>.</p>" @@ -797,20 +809,16 @@ "Arn", "ChannelName", "ChannelState", - "LogConfiguration", "Outputs", "PlaybackMode", - "Tier" + "Tier", + "LogConfiguration" ], "members":{ "Arn":{ "shape":"__string", "documentation":"<p>The ARN of the channel.</p>" }, - "Audiences":{ - "shape":"Audiences", - "documentation":"<p>The list of audiences defined in channel.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name of the channel.</p>" @@ -831,10 +839,6 @@ "shape":"__timestampUnix", "documentation":"<p>The timestamp of when the channel was last modified.</p>" }, - "LogConfiguration":{ - "shape":"LogConfigurationForChannel", - "documentation":"<p>The log configuration.</p>" - }, "Outputs":{ "shape":"ResponseOutputs", "documentation":"<p>The channel's output properties.</p>" @@ -851,6 +855,14 @@ "Tier":{ "shape":"__string", "documentation":"<p>The tier for this channel. STANDARD tier channels can contain live programs.</p>" + }, + "LogConfiguration":{ + "shape":"LogConfigurationForChannel", + "documentation":"<p>The log configuration.</p>" + }, + "Audiences":{ + "shape":"Audiences", + "documentation":"<p>The list of audiences defined in channel.</p>" } }, "documentation":"<p>The configuration parameters for a channel. For information about MediaTailor channels, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html\">Working with channels</a> in the <i>MediaTailor User Guide</i>.</p>" @@ -940,11 +952,15 @@ "members":{ "PercentEnabled":{ "shape":"__integer", - "documentation":"<p>The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html\">debug log mode</a>.</p> <p>Valid values: <code>0</code> - <code>100</code> </p>" + "documentation":"<p>The percentage of session logs that MediaTailor sends to your CloudWatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html\">debug log mode</a>.</p> <p>Valid values: <code>0</code> - <code>100</code> </p>" }, "PlaybackConfigurationName":{ "shape":"__string", "documentation":"<p>The name of the playback configuration.</p>" + }, + "EnabledLoggingStrategies":{ + "shape":"__listOfLoggingStrategies", + "documentation":"<p>The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose <code>LEGACY_CLOUDWATCH</code>. To configure MediaTailor to send logs to CloudWatch, which then vends the logs to your destination of choice, choose <code>VENDED_LOGS</code>. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.</p> <p>To use vended logs, you must configure the delivery destination in Amazon CloudWatch, as described in <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html#AWS-vended-logs-permissions-V2\">Enable logging from AWS services, Logging that requires additional permissions [V2]</a>.</p>" } }, "documentation":"<p>Configures Amazon CloudWatch log settings for a playback configuration.</p>" @@ -960,6 +976,10 @@ "PlaybackConfigurationName":{ "shape":"__string", "documentation":"<p>The name of the playback configuration.</p>" + }, + "EnabledLoggingStrategies":{ + "shape":"__listOfLoggingStrategies", + "documentation":"<p>The method used for collecting logs from AWS Elemental MediaTailor. <code>LEGACY_CLOUDWATCH</code> indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. <code>VENDED_LOGS</code> indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream. </p>" } } }, @@ -971,10 +991,6 @@ "PlaybackMode" ], "members":{ - "Audiences":{ - "shape":"Audiences", - "documentation":"<p>The list of audiences defined in channel.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name of the channel.</p>", @@ -1005,6 +1021,10 @@ "TimeShiftConfiguration":{ "shape":"TimeShiftConfiguration", "documentation":"<p> The time-shifted viewing configuration you want to associate to the channel. </p>" + }, + "Audiences":{ + "shape":"Audiences", + "documentation":"<p>The list of audiences defined in channel.</p>" } } }, @@ -1015,10 +1035,6 @@ "shape":"__string", "documentation":"<p>The Amazon Resource Name (ARN) to assign to the channel.</p>" }, - "Audiences":{ - "shape":"Audiences", - "documentation":"<p>The list of audiences defined in channel.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name to assign to the channel.</p>" @@ -1059,6 +1075,10 @@ "TimeShiftConfiguration":{ "shape":"TimeShiftConfiguration", "documentation":"<p> The time-shifted viewing configuration assigned to the channel. </p>" + }, + "Audiences":{ + "shape":"Audiences", + "documentation":"<p>The list of audiences defined in channel.</p>" } } }, @@ -1204,10 +1224,6 @@ "shape":"__listOfAdBreak", "documentation":"<p>The ad break configuration settings.</p>" }, - "AudienceMedia":{ - "shape":"__listOfAudienceMedia", - "documentation":"<p>The list of AudienceMedia defined in program.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name of the channel for this Program.</p>", @@ -1235,6 +1251,10 @@ "VodSourceName":{ "shape":"__string", "documentation":"<p>The name that's used to refer to a VOD source.</p>" + }, + "AudienceMedia":{ + "shape":"__listOfAudienceMedia", + "documentation":"<p>The list of AudienceMedia defined in program.</p>" } } }, @@ -1249,26 +1269,14 @@ "shape":"__string", "documentation":"<p>The ARN to assign to the program.</p>" }, - "AudienceMedia":{ - "shape":"__listOfAudienceMedia", - "documentation":"<p>The list of AudienceMedia defined in program.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name to assign to the channel for this program.</p>" }, - "ClipRange":{ - "shape":"ClipRange", - "documentation":"<p>The clip range configuration settings.</p>" - }, "CreationTime":{ "shape":"__timestampUnix", "documentation":"<p>The time the program was created.</p>" }, - "DurationMillis":{ - "shape":"__long", - "documentation":"<p>The duration of the live program in milliseconds.</p>" - }, "LiveSourceName":{ "shape":"__string", "documentation":"<p>The name of the LiveSource for this Program.</p>" @@ -1288,6 +1296,18 @@ "VodSourceName":{ "shape":"__string", "documentation":"<p>The name that's used to refer to a VOD source.</p>" + }, + "ClipRange":{ + "shape":"ClipRange", + "documentation":"<p>The clip range configuration settings.</p>" + }, + "DurationMillis":{ + "shape":"__long", + "documentation":"<p>The duration of the live program in milliseconds.</p>" + }, + "AudienceMedia":{ + "shape":"__listOfAudienceMedia", + "documentation":"<p>The list of AudienceMedia defined in program.</p>" } } }, @@ -1690,10 +1710,6 @@ "shape":"__string", "documentation":"<p>The ARN of the channel.</p>" }, - "Audiences":{ - "shape":"Audiences", - "documentation":"<p>The list of audiences defined in channel.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name of the channel.</p>" @@ -1714,10 +1730,6 @@ "shape":"__timestampUnix", "documentation":"<p>The timestamp of when the channel was last modified.</p>" }, - "LogConfiguration":{ - "shape":"LogConfigurationForChannel", - "documentation":"<p>The log configuration for the channel.</p>" - }, "Outputs":{ "shape":"ResponseOutputs", "documentation":"<p>The channel's output properties.</p>" @@ -1735,9 +1747,17 @@ "shape":"__string", "documentation":"<p>The channel's tier.</p>" }, + "LogConfiguration":{ + "shape":"LogConfigurationForChannel", + "documentation":"<p>The log configuration for the channel.</p>" + }, "TimeShiftConfiguration":{ "shape":"TimeShiftConfiguration", "documentation":"<p> The time-shifted viewing configuration for the channel. </p>" + }, + "Audiences":{ + "shape":"Audiences", + "documentation":"<p>The list of audiences defined in channel.</p>" } } }, @@ -1828,26 +1848,14 @@ "shape":"__string", "documentation":"<p>The ARN of the program.</p>" }, - "AudienceMedia":{ - "shape":"__listOfAudienceMedia", - "documentation":"<p>The list of AudienceMedia defined in program.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name of the channel that the program belongs to.</p>" }, - "ClipRange":{ - "shape":"ClipRange", - "documentation":"<p>The clip range configuration settings.</p>" - }, "CreationTime":{ "shape":"__timestampUnix", "documentation":"<p>The timestamp of when the program was created.</p>" }, - "DurationMillis":{ - "shape":"Long", - "documentation":"<p>The duration of the live program in milliseconds.</p>" - }, "LiveSourceName":{ "shape":"__string", "documentation":"<p>The name of the LiveSource for this Program.</p>" @@ -1867,6 +1875,18 @@ "VodSourceName":{ "shape":"__string", "documentation":"<p>The name that's used to refer to a VOD source.</p>" + }, + "ClipRange":{ + "shape":"ClipRange", + "documentation":"<p>The clip range configuration settings.</p>" + }, + "DurationMillis":{ + "shape":"Long", + "documentation":"<p>The duration of the live program in milliseconds.</p>" + }, + "AudienceMedia":{ + "shape":"__listOfAudienceMedia", + "documentation":"<p>The list of AudienceMedia defined in program.</p>" } } }, @@ -2015,12 +2035,6 @@ "type":"structure", "required":["ChannelName"], "members":{ - "Audience":{ - "shape":"__string", - "documentation":"<p>The single audience for GetChannelScheduleRequest.</p>", - "location":"querystring", - "locationName":"audience" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name of the channel associated with this Channel Schedule.</p>", @@ -2044,6 +2058,12 @@ "documentation":"<p>(Optional) If the playback configuration has more than <code>MaxResults</code> channel schedules, use <code>NextToken</code> to get the second and subsequent pages of results.</p> <p>For the first <code>GetChannelScheduleRequest</code> request, omit this value.</p> <p>For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p> <p>If the previous response didn't include a <code>NextToken</code> element, there are no more channel schedules to get.</p>", "location":"querystring", "locationName":"nextToken" + }, + "Audience":{ + "shape":"__string", + "documentation":"<p>The single audience for GetChannelScheduleRequest.</p>", + "location":"querystring", + "locationName":"audience" } } }, @@ -2093,7 +2113,7 @@ }, "ConfigurationAliases":{ "shape":"ConfigurationAliasesResponse", - "documentation":"<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html\">Domain Variables</a>.</p>" + "documentation":"<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domains.html\">Domain Variables</a>.</p>" }, "DashConfiguration":{ "shape":"DashConfiguration", @@ -2113,7 +2133,7 @@ }, "LogConfiguration":{ "shape":"LogConfiguration", - "documentation":"<p>The Amazon CloudWatch log settings for a playback configuration.</p>" + "documentation":"<p>The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.</p>" }, "ManifestProcessingRules":{ "shape":"ManifestProcessingRules", @@ -2155,6 +2175,10 @@ "VideoContentSourceUrl":{ "shape":"__string", "documentation":"<p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>" + }, + "AdConditioningConfiguration":{ + "shape":"AdConditioningConfiguration", + "documentation":"<p>The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads. </p>" } } }, @@ -2221,13 +2245,13 @@ "HlsPlaylistSettings":{ "type":"structure", "members":{ - "AdMarkupType":{ - "shape":"adMarkupTypes", - "documentation":"<p>Determines the type of SCTE 35 tags to use in ad markup. Specify <code>DATERANGE</code> to use <code>DATERANGE</code> tags (for live or VOD content). Specify <code>SCTE35_ENHANCED</code> to use <code>EXT-X-CUE-OUT</code> and <code>EXT-X-CUE-IN</code> tags (for VOD content only).</p>" - }, "ManifestWindowSeconds":{ "shape":"__integer", "documentation":"<p>The total duration (in seconds) of each manifest. Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.</p>" + }, + "AdMarkupType":{ + "shape":"adMarkupTypes", + "documentation":"<p>Determines the type of SCTE 35 tags to use in ad markup. Specify <code>DATERANGE</code> to use <code>DATERANGE</code> tags (for live or VOD content). Specify <code>SCTE35_ENHANCED</code> to use <code>EXT-X-CUE-OUT</code> and <code>EXT-X-CUE-IN</code> tags (for VOD content only).</p>" } }, "documentation":"<p>HLS playlist configuration parameters.</p>" @@ -2622,10 +2646,14 @@ "members":{ "PercentEnabled":{ "shape":"__integer", - "documentation":"<p>The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and <code>percentEnabled</code> is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html\">debug log mode</a>.</p> <p>Valid values: <code>0</code> - <code>100</code> </p>" + "documentation":"<p>The percentage of session logs that MediaTailor sends to your configured log destination. For example, if your playback configuration has 1000 sessions and <code>percentEnabled</code> is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html\">debug log mode</a>.</p> <p>Valid values: <code>0</code> - <code>100</code> </p>" + }, + "EnabledLoggingStrategies":{ + "shape":"__listOfLoggingStrategies", + "documentation":"<p>The method used for collecting logs from AWS Elemental MediaTailor. <code>LEGACY_CLOUDWATCH</code> indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. <code>VENDED_LOGS</code> indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream. </p>" } }, - "documentation":"<p>Returns Amazon CloudWatch log settings for a playback configuration.</p>" + "documentation":"<p>Defines where AWS Elemental MediaTailor sends logs for the playback configuration.</p>" }, "LogConfigurationForChannel":{ "type":"structure", @@ -2645,6 +2673,13 @@ "type":"list", "member":{"shape":"LogType"} }, + "LoggingStrategy":{ + "type":"string", + "enum":[ + "VENDED_LOGS", + "LEGACY_CLOUDWATCH" + ] + }, "Long":{ "type":"long", "box":true @@ -2712,7 +2747,7 @@ }, "ConfigurationAliases":{ "shape":"ConfigurationAliasesResponse", - "documentation":"<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html\">Domain Variables</a>.</p>" + "documentation":"<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domains.html\">Domain Variables</a>.</p>" }, "DashConfiguration":{ "shape":"DashConfiguration", @@ -2732,7 +2767,7 @@ }, "LogConfiguration":{ "shape":"LogConfiguration", - "documentation":"<p>The Amazon CloudWatch log settings for a playback configuration.</p>" + "documentation":"<p>Defines where AWS Elemental MediaTailor sends logs for the playback configuration.</p>" }, "ManifestProcessingRules":{ "shape":"ManifestProcessingRules", @@ -2774,6 +2809,10 @@ "VideoContentSourceUrl":{ "shape":"__string", "documentation":"<p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>" + }, + "AdConditioningConfiguration":{ + "shape":"AdConditioningConfiguration", + "documentation":"<p>The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.</p>" } }, "documentation":"<p>A playback configuration. For information about MediaTailor configurations, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html\">Working with configurations in AWS Elemental MediaTailor</a>.</p>" @@ -2799,7 +2838,7 @@ }, "StartTime":{ "shape":"__timestampUnix", - "documentation":"<p>The time when prefetched ads are considered for use in an ad break. If you don't specify <code>StartTime</code>, the prefetched ads are available after MediaTailor retrives them from the ad decision server.</p>" + "documentation":"<p>The time when prefetched ads are considered for use in an ad break. If you don't specify <code>StartTime</code>, the prefetched ads are available after MediaTailor retrieves them from the ad decision server.</p>" } }, "documentation":"<p>A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.</p>" @@ -2906,7 +2945,7 @@ }, "ConfigurationAliases":{ "shape":"ConfigurationAliasesRequest", - "documentation":"<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html\">Domain Variables</a>.</p>" + "documentation":"<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domains.html\">Domain Variables</a>.</p>" }, "DashConfiguration":{ "shape":"DashConfigurationForPut", @@ -2948,6 +2987,10 @@ "VideoContentSourceUrl":{ "shape":"__string", "documentation":"<p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>" + }, + "AdConditioningConfiguration":{ + "shape":"AdConditioningConfiguration", + "documentation":"<p>The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads. </p>" } } }, @@ -2972,7 +3015,7 @@ }, "ConfigurationAliases":{ "shape":"ConfigurationAliasesResponse", - "documentation":"<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html\">Domain Variables</a>.</p>" + "documentation":"<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domains.html\">Domain Variables</a>.</p>" }, "DashConfiguration":{ "shape":"DashConfiguration", @@ -2992,7 +3035,7 @@ }, "LogConfiguration":{ "shape":"LogConfiguration", - "documentation":"<p>The Amazon CloudWatch log settings for a playback configuration.</p>" + "documentation":"<p>The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.</p>" }, "ManifestProcessingRules":{ "shape":"ManifestProcessingRules", @@ -3034,6 +3077,10 @@ "VideoContentSourceUrl":{ "shape":"__string", "documentation":"<p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>" + }, + "AdConditioningConfiguration":{ + "shape":"AdConditioningConfiguration", + "documentation":"<p>The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads. </p>" } } }, @@ -3136,13 +3183,13 @@ "type":"structure", "required":["Transition"], "members":{ - "ClipRange":{ - "shape":"ClipRange", - "documentation":"<p>Program clip range configuration.</p>" - }, "Transition":{ "shape":"Transition", "documentation":"<p>Program transition configurations.</p>" + }, + "ClipRange":{ + "shape":"ClipRange", + "documentation":"<p>Program clip range configuration.</p>" } }, "documentation":"<p>Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.</p>" @@ -3168,10 +3215,6 @@ "shape":"__string", "documentation":"<p>The ARN of the program.</p>" }, - "Audiences":{ - "shape":"Audiences", - "documentation":"<p>The list of audiences defined in ScheduleEntry.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name of the channel that uses this schedule.</p>" @@ -3199,6 +3242,10 @@ "VodSourceName":{ "shape":"__string", "documentation":"<p>The name of the VOD source.</p>" + }, + "Audiences":{ + "shape":"Audiences", + "documentation":"<p>The list of audiences defined in ScheduleEntry.</p>" } }, "documentation":"<p>The properties for a schedule.</p>" @@ -3246,25 +3293,25 @@ "SegmentationDescriptor":{ "type":"structure", "members":{ - "SegmentNum":{ - "shape":"Integer", - "documentation":"<p>The segment number to assign to the <code>segmentation_descriptor.segment_num</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.</p>" - }, "SegmentationEventId":{ "shape":"Integer", "documentation":"<p>The Event Identifier to assign to the <code>segmentation_descriptor.segmentation_event_id</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.</p>" }, - "SegmentationTypeId":{ + "SegmentationUpidType":{ "shape":"Integer", - "documentation":"<p>The Type Identifier to assign to the <code>segmentation_descriptor.segmentation_type_id</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.</p>" + "documentation":"<p>The Upid Type to assign to the <code>segmentation_descriptor.segmentation_upid_type</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.</p>" }, "SegmentationUpid":{ "shape":"String", "documentation":"<p>The Upid to assign to the <code>segmentation_descriptor.segmentation_upid</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is \"\" (an empty string).</p>" }, - "SegmentationUpidType":{ + "SegmentationTypeId":{ "shape":"Integer", - "documentation":"<p>The Upid Type to assign to the <code>segmentation_descriptor.segmentation_upid_type</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.</p>" + "documentation":"<p>The Type Identifier to assign to the <code>segmentation_descriptor.segmentation_type_id</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.</p>" + }, + "SegmentNum":{ + "shape":"Integer", + "documentation":"<p>The segment number to assign to the <code>segmentation_descriptor.segment_num</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.</p>" }, "SegmentsExpected":{ "shape":"Integer", @@ -3403,6 +3450,13 @@ "members":{ } }, + "StreamingMediaFileConditioning":{ + "type":"string", + "enum":[ + "TRANSCODE", + "NONE" + ] + }, "String":{"type":"string"}, "TagResourceRequest":{ "type":"structure", @@ -3517,10 +3571,6 @@ "Outputs" ], "members":{ - "Audiences":{ - "shape":"Audiences", - "documentation":"<p>The list of audiences defined in channel.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name of the channel.</p>", @@ -3538,6 +3588,10 @@ "TimeShiftConfiguration":{ "shape":"TimeShiftConfiguration", "documentation":"<p> The time-shifted viewing configuration you want to associate to the channel. </p>" + }, + "Audiences":{ + "shape":"Audiences", + "documentation":"<p>The list of audiences defined in channel.</p>" } } }, @@ -3548,10 +3602,6 @@ "shape":"__string", "documentation":"<p>The Amazon Resource Name (ARN) associated with the channel.</p>" }, - "Audiences":{ - "shape":"Audiences", - "documentation":"<p>The list of audiences defined in channel.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name of the channel.</p>" @@ -3592,6 +3642,10 @@ "TimeShiftConfiguration":{ "shape":"TimeShiftConfiguration", "documentation":"<p> The time-shifted viewing configuration for the channel. </p>" + }, + "Audiences":{ + "shape":"Audiences", + "documentation":"<p>The list of audiences defined in channel.</p>" } } }, @@ -3667,10 +3721,6 @@ "shape":"__listOfAdBreak", "documentation":"<p>The ad break configuration settings.</p>" }, - "AudienceMedia":{ - "shape":"__listOfAudienceMedia", - "documentation":"<p>The list of AudienceMedia defined in program.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name of the channel for this Program.</p>", @@ -3686,6 +3736,10 @@ "ScheduleConfiguration":{ "shape":"UpdateProgramScheduleConfiguration", "documentation":"<p>The schedule configuration settings.</p>" + }, + "AudienceMedia":{ + "shape":"__listOfAudienceMedia", + "documentation":"<p>The list of AudienceMedia defined in program.</p>" } } }, @@ -3700,38 +3754,18 @@ "shape":"__string", "documentation":"<p>The ARN to assign to the program.</p>" }, - "AudienceMedia":{ - "shape":"__listOfAudienceMedia", - "documentation":"<p>The list of AudienceMedia defined in program.</p>" - }, "ChannelName":{ "shape":"__string", "documentation":"<p>The name to assign to the channel for this program.</p>" }, - "ClipRange":{ - "shape":"ClipRange", - "documentation":"<p>The clip range configuration settings.</p>" - }, "CreationTime":{ "shape":"__timestampUnix", "documentation":"<p>The time the program was created.</p>" }, - "DurationMillis":{ - "shape":"__long", - "documentation":"<p>The duration of the live program in milliseconds.</p>" - }, - "LiveSourceName":{ - "shape":"__string", - "documentation":"<p>The name of the LiveSource for this Program.</p>" - }, "ProgramName":{ "shape":"__string", "documentation":"<p>The name to assign to this program.</p>" }, - "ScheduledStartTime":{ - "shape":"__timestampUnix", - "documentation":"<p>The scheduled start time for this Program.</p>" - }, "SourceLocationName":{ "shape":"__string", "documentation":"<p>The name to assign to the source location for this program.</p>" @@ -3739,19 +3773,39 @@ "VodSourceName":{ "shape":"__string", "documentation":"<p>The name that's used to refer to a VOD source.</p>" + }, + "LiveSourceName":{ + "shape":"__string", + "documentation":"<p>The name of the LiveSource for this Program.</p>" + }, + "ClipRange":{ + "shape":"ClipRange", + "documentation":"<p>The clip range configuration settings.</p>" + }, + "DurationMillis":{ + "shape":"__long", + "documentation":"<p>The duration of the live program in milliseconds.</p>" + }, + "ScheduledStartTime":{ + "shape":"__timestampUnix", + "documentation":"<p>The scheduled start time for this Program.</p>" + }, + "AudienceMedia":{ + "shape":"__listOfAudienceMedia", + "documentation":"<p>The list of AudienceMedia defined in program.</p>" } } }, "UpdateProgramScheduleConfiguration":{ "type":"structure", "members":{ - "ClipRange":{ - "shape":"ClipRange", - "documentation":"<p>Program clip range configuration.</p>" - }, "Transition":{ "shape":"UpdateProgramTransition", "documentation":"<p>Program transition configuration.</p>" + }, + "ClipRange":{ + "shape":"ClipRange", + "documentation":"<p>Program clip range configuration.</p>" } }, "documentation":"<p>Schedule configuration parameters.</p>" @@ -3759,13 +3813,13 @@ "UpdateProgramTransition":{ "type":"structure", "members":{ - "DurationMillis":{ - "shape":"__long", - "documentation":"<p>The duration of the live program in seconds.</p>" - }, "ScheduledStartTimeMillis":{ "shape":"__long", "documentation":"<p>The date and time that the program is scheduled to start, in epoch milliseconds.</p>" + }, + "DurationMillis":{ + "shape":"__long", + "documentation":"<p>The duration of the live program in seconds.</p>" } }, "documentation":"<p>Program transition configuration.</p>" @@ -3991,6 +4045,10 @@ "type":"list", "member":{"shape":"LiveSource"} }, + "__listOfLoggingStrategies":{ + "type":"list", + "member":{"shape":"LoggingStrategy"} + }, "__listOfPlaybackConfiguration":{ "type":"list", "member":{"shape":"PlaybackConfiguration"} diff --git a/contrib/python/botocore/py3/botocore/data/neptune-graph/2023-11-29/service-2.json b/contrib/python/botocore/py3/botocore/data/neptune-graph/2023-11-29/service-2.json index 9bb534b80cf..6575ec214c5 100644 --- a/contrib/python/botocore/py3/botocore/data/neptune-graph/2023-11-29/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/neptune-graph/2023-11-29/service-2.json @@ -6,7 +6,6 @@ "endpointPrefix":"neptune-graph", "protocol":"rest-json", "protocols":["rest-json"], - "ripServiceName":"neptune-graph", "serviceAbbreviation":"Neptune Graph", "serviceFullName":"Amazon Neptune Graph", "serviceId":"Neptune Graph", @@ -1101,7 +1100,7 @@ }, "maxProvisionedMemory":{ "shape":"ProvisionedMemory", - "documentation":"<p>The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account.</p> <p> If both the minimum and maximum values are specified, the max of the <code>min-provisioned-memory</code> and <code>max-provisioned memory</code> is used to create the graph. If neither value is specified 128 m-NCUs are used.</p>" + "documentation":"<p>The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account.</p> <p> If both the minimum and maximum values are specified, the final <code>provisioned-memory</code> will be chosen per the actual size of your imported data. If neither value is specified, 128 m-NCUs are used.</p>" }, "minProvisionedMemory":{ "shape":"ProvisionedMemory", @@ -2445,6 +2444,12 @@ "ListExportTasksInput":{ "type":"structure", "members":{ + "graphIdentifier":{ + "shape":"GraphIdentifier", + "documentation":"<p>The unique identifier of the Neptune Analytics graph.</p>", + "location":"querystring", + "locationName":"graphIdentifier" + }, "nextToken":{ "shape":"PaginationToken", "documentation":"<p>Pagination token used to paginate input.</p>", diff --git a/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/paginators-1.json b/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/paginators-1.json index 868d06615d0..420341b839a 100644 --- a/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/paginators-1.json @@ -29,6 +29,18 @@ "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "TLSInspectionConfigurations" + }, + "GetAnalysisReportResults": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "AnalysisReportResults" + }, + "ListAnalysisReports": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "AnalysisReports" } } } diff --git a/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/paginators-1.sdk-extras.json b/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/paginators-1.sdk-extras.json new file mode 100644 index 00000000000..2d9612ecb37 --- /dev/null +++ b/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/paginators-1.sdk-extras.json @@ -0,0 +1,16 @@ +{ + "version": 1.0, + "merge": { + "pagination": { + "GetAnalysisReportResults": { + "non_aggregate_keys": [ + "EndTime", + "ReportTime", + "Status", + "AnalysisType", + "StartTime" + ] + } + } + } +} diff --git a/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/service-2.json b/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/service-2.json index 834fa0f83a9..504888d2082 100644 --- a/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/network-firewall/2020-11-12/service-2.json @@ -69,7 +69,7 @@ {"shape":"InsufficientCapacityException"}, {"shape":"InvalidOperationException"} ], - "documentation":"<p>Creates an Network Firewall <a>Firewall</a> and accompanying <a>FirewallStatus</a> for a VPC. </p> <p>The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource. </p> <p>After you create a firewall, you can provide additional settings, like the logging configuration. </p> <p>To update the settings for a firewall, you use the operations that apply to the settings themselves, for example <a>UpdateLoggingConfiguration</a>, <a>AssociateSubnets</a>, and <a>UpdateFirewallDeleteProtection</a>. </p> <p>To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, <a>ListTagsForResource</a>, <a>TagResource</a>, and <a>UntagResource</a>.</p> <p>To retrieve information about firewalls, use <a>ListFirewalls</a> and <a>DescribeFirewall</a>.</p>" + "documentation":"<p>Creates an Network Firewall <a>Firewall</a> and accompanying <a>FirewallStatus</a> for a VPC. </p> <p>The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource. </p> <p>After you create a firewall, you can provide additional settings, like the logging configuration. </p> <p>To update the settings for a firewall, you use the operations that apply to the settings themselves, for example <a>UpdateLoggingConfiguration</a>, <a>AssociateSubnets</a>, and <a>UpdateFirewallDeleteProtection</a>. </p> <p>To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, <a>ListTagsForResource</a>, <a>TagResource</a>, and <a>UntagResource</a>.</p> <p>To retrieve information about firewalls, use <a>ListFirewalls</a> and <a>DescribeFirewall</a>.</p> <p>To generate a report on the last 30 days of traffic monitored by a firewall, use <a>StartAnalysisReport</a>.</p>" }, "CreateFirewallPolicy":{ "name":"CreateFirewallPolicy", @@ -340,6 +340,38 @@ ], "documentation":"<p>Removes the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering protections that the endpoints were providing. </p>" }, + "GetAnalysisReportResults":{ + "name":"GetAnalysisReportResults", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAnalysisReportResultsRequest"}, + "output":{"shape":"GetAnalysisReportResultsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>The results of a <code>COMPLETED</code> analysis report generated with <a>StartAnalysisReport</a>.</p> <p>For more information, see <a>AnalysisTypeReportResult</a>. </p>" + }, + "ListAnalysisReports":{ + "name":"ListAnalysisReports", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAnalysisReportsRequest"}, + "output":{"shape":"ListAnalysisReportsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Returns a list of all traffic analysis reports generated within the last 30 days.</p>" + }, "ListFirewallPolicies":{ "name":"ListFirewallPolicies", "http":{ @@ -433,6 +465,22 @@ ], "documentation":"<p>Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service to manage resource sharing for Network Firewall. </p> <p>Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform. </p> <p>When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy. </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_GetResourceShareInvitations.html\">GetResourceShareInvitations</a> - Returns the Amazon Resource Names (ARNs) of the resource share invitations. </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_AcceptResourceShareInvitation.html\">AcceptResourceShareInvitation</a> - Accepts the share invitation for a specified resource share. </p> </li> </ul> <p>For additional information about resource sharing using RAM, see <a href=\"https://docs.aws.amazon.com/ram/latest/userguide/what-is.html\">Resource Access Manager User Guide</a>.</p>" }, + "StartAnalysisReport":{ + "name":"StartAnalysisReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAnalysisReportRequest"}, + "output":{"shape":"StartAnalysisReportResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Generates a traffic analysis report for the timeframe and traffic type you specify.</p> <p>For information on the contents of a traffic analysis report, see <a>AnalysisReport</a>.</p>" + }, "TagResource":{ "name":"TagResource", "http":{ @@ -465,6 +513,22 @@ ], "documentation":"<p>Removes the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.</p> <p>You can manage tags for the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall policies, and rule groups. </p>" }, + "UpdateFirewallAnalysisSettings":{ + "name":"UpdateFirewallAnalysisSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFirewallAnalysisSettingsRequest"}, + "output":{"shape":"UpdateFirewallAnalysisSettingsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Enables specific types of firewall analysis on a specific firewall you define.</p>" + }, "UpdateFirewallDeleteProtection":{ "name":"UpdateFirewallDeleteProtection", "http":{ @@ -662,6 +726,47 @@ "type":"list", "member":{"shape":"Address"} }, + "AnalysisReport":{ + "type":"structure", + "members":{ + "AnalysisReportId":{ + "shape":"AnalysisReportId", + "documentation":"<p>The unique ID of the query that ran when you requested an analysis report. </p>" + }, + "AnalysisType":{ + "shape":"EnabledAnalysisType", + "documentation":"<p>The type of traffic that will be used to generate a report. </p>" + }, + "ReportTime":{ + "shape":"ReportTime", + "documentation":"<p>The date and time the analysis report was ran. </p>" + }, + "Status":{ + "shape":"Status", + "documentation":"<p>The status of the analysis report you specify. Statuses include <code>RUNNING</code>, <code>COMPLETED</code>, or <code>FAILED</code>.</p>" + } + }, + "documentation":"<p>A report that captures key activity from the last 30 days of network traffic monitored by your firewall.</p> <p>You can generate up to one report per traffic type, per 30 day period. For example, when you successfully create an HTTP traffic report, you cannot create another HTTP traffic report until 30 days pass. Alternatively, if you generate a report that combines metrics on both HTTP and HTTPS traffic, you cannot create another report for either traffic type until 30 days pass.</p>" + }, + "AnalysisReportId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"\\S+" + }, + "AnalysisReportNextToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "AnalysisReportResults":{ + "type":"list", + "member":{"shape":"AnalysisTypeReportResult"} + }, + "AnalysisReports":{ + "type":"list", + "member":{"shape":"AnalysisReport"} + }, "AnalysisResult":{ "type":"structure", "members":{ @@ -678,12 +783,42 @@ "documentation":"<p>Provides analysis details for the identified rule.</p>" } }, - "documentation":"<p>The analysis result for Network Firewall's stateless rule group analyzer. Every time you call <a>CreateRuleGroup</a>, <a>UpdateRuleGroup</a>, or <a>DescribeRuleGroup</a> on a stateless rule group, Network Firewall analyzes the stateless rule groups in your account and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in a list of analysis results.</p>" + "documentation":"<p>The analysis result for Network Firewall's stateless rule group analyzer. Every time you call <a>CreateRuleGroup</a>, <a>UpdateRuleGroup</a>, or <a>DescribeRuleGroup</a> on a stateless rule group, Network Firewall analyzes the stateless rule groups in your account and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in a list of analysis results.</p> <p>The <code>AnalysisResult</code> data type is not related to traffic analysis reports you generate using <a>StartAnalysisReport</a>. For information on traffic analysis report results, see <a>AnalysisTypeReportResult</a>.</p>" }, "AnalysisResultList":{ "type":"list", "member":{"shape":"AnalysisResult"} }, + "AnalysisTypeReportResult":{ + "type":"structure", + "members":{ + "Protocol":{ + "shape":"CollectionMember_String", + "documentation":"<p>The type of traffic captured by the analysis report.</p>" + }, + "FirstAccessed":{ + "shape":"FirstAccessed", + "documentation":"<p>The date and time any domain was first accessed (within the last 30 day period).</p>" + }, + "LastAccessed":{ + "shape":"LastAccessed", + "documentation":"<p>The date and time any domain was last accessed (within the last 30 day period).</p>" + }, + "Domain":{ + "shape":"Domain", + "documentation":"<p>The most frequently accessed domains.</p>" + }, + "Hits":{ + "shape":"Hits", + "documentation":"<p>The number of attempts made to access a observed domain.</p>" + }, + "UniqueSources":{ + "shape":"UniqueSources", + "documentation":"<p>The number of unique source IP addresses that connected to a domain.</p>" + } + }, + "documentation":"<p>The results of a <code>COMPLETED</code> analysis report generated with <a>StartAnalysisReport</a>.</p> <p>For an example of traffic analysis report results, see the response syntax of <a>GetAnalysisReportResults</a>.</p>" + }, "AssociateFirewallPolicyRequest":{ "type":"structure", "required":["FirewallPolicyArn"], @@ -875,6 +1010,7 @@ "CAPACITY_CONSTRAINED" ] }, + "Count":{"type":"integer"}, "CreateFirewallPolicyRequest":{ "type":"structure", "required":[ @@ -929,9 +1065,7 @@ "type":"structure", "required":[ "FirewallName", - "FirewallPolicyArn", - "VpcId", - "SubnetMappings" + "FirewallPolicyArn" ], "members":{ "FirewallName":{ @@ -973,6 +1107,10 @@ "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"<p>A complex type that contains settings for encryption of your firewall resources.</p>" + }, + "EnabledAnalysisTypes":{ + "shape":"EnabledAnalysisTypes", + "documentation":"<p>An optional setting indicating the specific traffic analysis types to enable on the firewall. </p>" } } }, @@ -1543,6 +1681,18 @@ } } }, + "Domain":{"type":"string"}, + "EnabledAnalysisType":{ + "type":"string", + "enum":[ + "TLS_SNI", + "HTTP_HOST" + ] + }, + "EnabledAnalysisTypes":{ + "type":"list", + "member":{"shape":"EnabledAnalysisType"} + }, "EncryptionConfiguration":{ "type":"structure", "required":["Type"], @@ -1565,6 +1715,7 @@ "AWS_OWNED_KMS_KEY" ] }, + "EndTime":{"type":"timestamp"}, "EndpointId":{"type":"string"}, "ErrorMessage":{"type":"string"}, "Firewall":{ @@ -1623,6 +1774,10 @@ "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"<p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.</p>" + }, + "EnabledAnalysisTypes":{ + "shape":"EnabledAnalysisTypes", + "documentation":"<p>An optional setting indicating the specific traffic analysis types to enable on the firewall. </p>" } }, "documentation":"<p>The firewall defines the configuration settings for an Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource. </p> <p>The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding <a>FirewallStatus</a>. You can retrieve both objects by calling <a>DescribeFirewall</a>.</p>" @@ -1798,6 +1953,7 @@ "type":"list", "member":{"shape":"FirewallMetadata"} }, + "FirstAccessed":{"type":"timestamp"}, "Flags":{ "type":"list", "member":{"shape":"TCPFlag"} @@ -1819,6 +1975,65 @@ "DENYLIST" ] }, + "GetAnalysisReportResultsRequest":{ + "type":"structure", + "required":["AnalysisReportId"], + "members":{ + "FirewallName":{ + "shape":"ResourceName", + "documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>" + }, + "AnalysisReportId":{ + "shape":"AnalysisReportId", + "documentation":"<p>The unique ID of the query that ran when you requested an analysis report. </p>" + }, + "FirewallArn":{ + "shape":"ResourceArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>" + }, + "NextToken":{ + "shape":"AnalysisReportNextToken", + "documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>" + }, + "MaxResults":{ + "shape":"PaginationMaxResults", + "documentation":"<p>The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>" + } + } + }, + "GetAnalysisReportResultsResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"Status", + "documentation":"<p>The status of the analysis report you specify. Statuses include <code>RUNNING</code>, <code>COMPLETED</code>, or <code>FAILED</code>.</p>" + }, + "StartTime":{ + "shape":"StartTime", + "documentation":"<p> The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, <code>YYYY-MM-DDTHH:MM:SSZ</code>. </p>" + }, + "EndTime":{ + "shape":"EndTime", + "documentation":"<p>The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, <code>YYYY-MM-DDTHH:MM:SSZ</code>). </p>" + }, + "ReportTime":{ + "shape":"ReportTime", + "documentation":"<p>The date and time the analysis report was ran. </p>" + }, + "AnalysisType":{ + "shape":"EnabledAnalysisType", + "documentation":"<p>The type of traffic that will be used to generate a report. </p>" + }, + "NextToken":{ + "shape":"AnalysisReportNextToken", + "documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>" + }, + "AnalysisReportResults":{ + "shape":"AnalysisReportResults", + "documentation":"<p>Retrieves the results of a traffic analysis report.</p>" + } + } + }, "HashMapKey":{ "type":"string", "max":50, @@ -1869,6 +2084,16 @@ }, "documentation":"<p>The basic rule criteria for Network Firewall to use to inspect packet headers in stateful traffic flow inspection. Traffic flows that match the criteria are a match for the corresponding <a>StatefulRule</a>. </p>" }, + "Hits":{ + "type":"structure", + "members":{ + "Count":{ + "shape":"Count", + "documentation":"<p>The number of attempts made to access a domain.</p>" + } + }, + "documentation":"<p>Attempts made to a access domain.</p>" + }, "IPAddressType":{ "type":"string", "enum":[ @@ -1999,6 +2224,7 @@ "min":1, "pattern":".*" }, + "LastAccessed":{"type":"timestamp"}, "LastUpdateTime":{"type":"timestamp"}, "LimitExceededException":{ "type":"structure", @@ -2008,6 +2234,40 @@ "documentation":"<p>Unable to perform the operation because doing so would violate a limit setting. </p>", "exception":true }, + "ListAnalysisReportsRequest":{ + "type":"structure", + "members":{ + "FirewallName":{ + "shape":"ResourceName", + "documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>" + }, + "FirewallArn":{ + "shape":"ResourceArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>" + }, + "MaxResults":{ + "shape":"PaginationMaxResults", + "documentation":"<p>The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>" + } + } + }, + "ListAnalysisReportsResponse":{ + "type":"structure", + "members":{ + "AnalysisReports":{ + "shape":"AnalysisReports", + "documentation":"<p>The <code>id</code> and <code>ReportTime</code> associated with a requested analysis report. Does not provide the status of the analysis report. </p>" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"<p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>" + } + } + }, "ListFirewallPoliciesRequest":{ "type":"structure", "members":{ @@ -2418,6 +2678,7 @@ }, "documentation":"<p>Contains a set of IP set references.</p>" }, + "ReportTime":{"type":"timestamp"}, "ResourceArn":{ "type":"string", "max":256, @@ -2630,11 +2891,11 @@ "members":{ "Keyword":{ "shape":"Keyword", - "documentation":"<p>The keyword for the Suricata compatible rule option. You must include a <code>sid</code> (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see <a href=\"https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options\">Rule options</a> in the Suricata documentation.</p>" + "documentation":"<p>The keyword for the Suricata compatible rule option. You must include a <code>sid</code> (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see <a href=\"https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html#rule-options\">Rule options</a> in the Suricata documentation.</p>" }, "Settings":{ "shape":"Settings", - "documentation":"<p>The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the <code>Keyword</code>. For more information about the settings for specific options, see <a href=\"https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options\">Rule options</a>.</p>" + "documentation":"<p>The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the <code>Keyword</code>. For more information about the settings for specific options, see <a href=\"https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html#rule-options\">Rule options</a>.</p>" } }, "documentation":"<p>Additional settings for a stateful rule. This is part of the <a>StatefulRule</a> configuration.</p>" @@ -2687,7 +2948,7 @@ }, "StatefulRules":{ "shape":"StatefulRules", - "documentation":"<p>An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata <code>Rules</code> format, see <a href=\"https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html\">Rules Format</a>. </p>" + "documentation":"<p>An array of individual stateful rules inspection criteria to be used together in a stateful rule group. Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata <code>Rules</code> format, see <a href=\"https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html\">Rules Format</a>. </p>" }, "StatelessRulesAndCustomActions":{ "shape":"StatelessRulesAndCustomActions", @@ -2824,6 +3085,35 @@ }, "documentation":"<p>High-level information about the managed rule group that your own rule group is copied from. You can use the the metadata to track version updates made to the originating rule group. You can retrieve all objects for a rule group by calling <a href=\"https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html\">DescribeRuleGroup</a>.</p>" }, + "StartAnalysisReportRequest":{ + "type":"structure", + "required":["AnalysisType"], + "members":{ + "FirewallName":{ + "shape":"ResourceName", + "documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>" + }, + "FirewallArn":{ + "shape":"ResourceArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>" + }, + "AnalysisType":{ + "shape":"EnabledAnalysisType", + "documentation":"<p>The type of traffic that will be used to generate a report. </p>" + } + } + }, + "StartAnalysisReportResponse":{ + "type":"structure", + "required":["AnalysisReportId"], + "members":{ + "AnalysisReportId":{ + "shape":"AnalysisReportId", + "documentation":"<p>The unique ID of the query that ran when you requested an analysis report. </p>" + } + } + }, + "StartTime":{"type":"timestamp"}, "StatefulAction":{ "type":"string", "enum":[ @@ -2876,7 +3166,7 @@ "documentation":"<p>Additional options for the rule. These are the Suricata <code>RuleOptions</code> settings.</p>" } }, - "documentation":"<p>A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata <code>Rules</code> format, see <a href=\"https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html\">Rules Format</a>. </p>" + "documentation":"<p>A single Suricata rules specification, for use in a stateful rule group. Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata <code>Rules</code> format, see <a href=\"https://suricata.readthedocs.io/en/suricata-7.0.3/rules/intro.html\">Rules Format</a>. </p>" }, "StatefulRuleDirection":{ "type":"string", @@ -3020,6 +3310,7 @@ }, "documentation":"<p>Stateless inspection criteria. Each stateless rule group uses exactly one of these data types to define its stateless rules. </p>" }, + "Status":{"type":"string"}, "StatusMessage":{"type":"string"}, "StatusReason":{ "type":"string", @@ -3301,6 +3592,16 @@ }, "documentation":"<p>Contains metadata about an Certificate Manager certificate.</p>" }, + "UniqueSources":{ + "type":"structure", + "members":{ + "Count":{ + "shape":"Count", + "documentation":"<p>The number of unique source IP addresses that connected to a domain.</p>" + } + }, + "documentation":"<p>A unique source IP address that connected to a domain.</p>" + }, "UnsupportedOperationException":{ "type":"structure", "members":{ @@ -3331,6 +3632,48 @@ "members":{ } }, + "UpdateFirewallAnalysisSettingsRequest":{ + "type":"structure", + "members":{ + "EnabledAnalysisTypes":{ + "shape":"EnabledAnalysisTypes", + "documentation":"<p>An optional setting indicating the specific traffic analysis types to enable on the firewall. </p>" + }, + "FirewallArn":{ + "shape":"ResourceArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>" + }, + "FirewallName":{ + "shape":"ResourceName", + "documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>" + }, + "UpdateToken":{ + "shape":"UpdateToken", + "documentation":"<p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p> <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p> <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>" + } + } + }, + "UpdateFirewallAnalysisSettingsResponse":{ + "type":"structure", + "members":{ + "EnabledAnalysisTypes":{ + "shape":"EnabledAnalysisTypes", + "documentation":"<p>An optional setting indicating the specific traffic analysis types to enable on the firewall. </p>" + }, + "FirewallArn":{ + "shape":"ResourceArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>" + }, + "FirewallName":{ + "shape":"ResourceName", + "documentation":"<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>" + }, + "UpdateToken":{ + "shape":"UpdateToken", + "documentation":"<p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p> <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p> <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>" + } + } + }, "UpdateFirewallDeleteProtectionRequest":{ "type":"structure", "required":["DeleteProtection"], @@ -3766,5 +4109,5 @@ "member":{"shape":"VpcId"} } }, - "documentation":"<p>This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors. </p> <p>The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-apis.html\">Amazon Web Services APIs</a>. </p> <p>To view the complete list of Amazon Web Services Regions where Network Firewall is available, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/network-firewall.html\">Service endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>. </p> <p>To access Network Firewall using the IPv4 REST API endpoint: <code>https://network-firewall.<region>.amazonaws.com </code> </p> <p>To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API endpoint: <code>https://network-firewall.<region>.aws.api </code> </p> <p>Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">Amazon Web Services SDKs</a>.</p> <p>For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/\">Network Firewall Developer Guide</a>.</p> <p>Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. </p> <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples: </p> <ul> <li> <p>Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.</p> </li> <li> <p>Use custom lists of known bad domains to limit the types of domain names that your applications can access.</p> </li> <li> <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p> </li> <li> <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.</p> </li> </ul> <p>To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/\">Amazon VPC User Guide</a>.</p> <p>To start using Network Firewall, do the following: </p> <ol> <li> <p>(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC. </p> </li> <li> <p>In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall. </p> </li> <li> <p>In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have. </p> </li> <li> <p>In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior. </p> </li> <li> <p>In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.</p> </li> <li> <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.</p> </li> </ol>" + "documentation":"<p>This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors. </p> <p>The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-apis.html\">Amazon Web Services APIs</a>. </p> <p>To view the complete list of Amazon Web Services Regions where Network Firewall is available, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/network-firewall.html\">Service endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>. </p> <p>To access Network Firewall using the IPv4 REST API endpoint: <code>https://network-firewall.<region>.amazonaws.com </code> </p> <p>To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API endpoint: <code>https://network-firewall.<region>.aws.api </code> </p> <p>Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">Amazon Web Services SDKs</a>.</p> <p>For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/\">Network Firewall Developer Guide</a>.</p> <p>Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 7.0.3. For information about Suricata, see the <a href=\"https://suricata.io/\">Suricata website</a> and the <a href=\"https://suricata.readthedocs.io/en/suricata-7.0.3/\">Suricata User Guide</a>. </p> <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples: </p> <ul> <li> <p>Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.</p> </li> <li> <p>Use custom lists of known bad domains to limit the types of domain names that your applications can access.</p> </li> <li> <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p> </li> <li> <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.</p> </li> </ul> <p>To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/\">Amazon VPC User Guide</a>.</p> <p>To start using Network Firewall, do the following: </p> <ol> <li> <p>(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC. </p> </li> <li> <p>In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall. </p> </li> <li> <p>In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have. </p> </li> <li> <p>In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior. </p> </li> <li> <p>In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.</p> </li> <li> <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.</p> </li> </ol>" } diff --git a/contrib/python/botocore/py3/botocore/data/notifications/2018-05-10/paginators-1.json b/contrib/python/botocore/py3/botocore/data/notifications/2018-05-10/paginators-1.json index d3eca60dd4a..8cd3019370e 100644 --- a/contrib/python/botocore/py3/botocore/data/notifications/2018-05-10/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/notifications/2018-05-10/paginators-1.json @@ -29,6 +29,30 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "notificationHubs" + }, + "ListManagedNotificationChannelAssociations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "channelAssociations" + }, + "ListManagedNotificationChildEvents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "managedNotificationChildEvents" + }, + "ListManagedNotificationConfigurations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "managedNotificationConfigurations" + }, + "ListManagedNotificationEvents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "managedNotificationEvents" } } } diff --git a/contrib/python/botocore/py3/botocore/data/notifications/2018-05-10/service-2.json b/contrib/python/botocore/py3/botocore/data/notifications/2018-05-10/service-2.json index 13b0c9b03c5..86b5971e466 100644 --- a/contrib/python/botocore/py3/botocore/data/notifications/2018-05-10/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/notifications/2018-05-10/service-2.json @@ -31,7 +31,49 @@ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Associates a delivery <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/managing-delivery-channels.html\">Channel</a> with a particular NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).</p>", + "documentation":"<p>Associates a delivery <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/managing-delivery-channels.html\">Channel</a> with a particular <code>NotificationConfiguration</code>. Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).</p>", + "idempotent":true + }, + "AssociateManagedNotificationAccountContact":{ + "name":"AssociateManagedNotificationAccountContact", + "http":{ + "method":"PUT", + "requestUri":"/contacts/associate-managed-notification/{contactIdentifier}", + "responseCode":201 + }, + "input":{"shape":"AssociateManagedNotificationAccountContactRequest"}, + "output":{"shape":"AssociateManagedNotificationAccountContactResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Associates an Account Contact with a particular <code>ManagedNotificationConfiguration</code>.</p>", + "idempotent":true + }, + "AssociateManagedNotificationAdditionalChannel":{ + "name":"AssociateManagedNotificationAdditionalChannel", + "http":{ + "method":"PUT", + "requestUri":"/channels/associate-managed-notification/{channelArn}", + "responseCode":201 + }, + "input":{"shape":"AssociateManagedNotificationAdditionalChannelRequest"}, + "output":{"shape":"AssociateManagedNotificationAdditionalChannelResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Associates an additional Channel with a particular <code>ManagedNotificationConfiguration</code>.</p> <p>Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).</p>", "idempotent":true }, "CreateEventRule":{ @@ -52,7 +94,7 @@ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Creates an <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/glossary.html\">EventRule</a> that is associated with a specified Notification Configuration.</p>", + "documentation":"<p>Creates an <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/glossary.html\"> <code>EventRule</code> </a> that is associated with a specified <code>NotificationConfiguration</code>.</p>", "idempotent":true }, "CreateNotificationConfiguration":{ @@ -72,7 +114,7 @@ {"shape":"ThrottlingException"}, {"shape":"ConflictException"} ], - "documentation":"<p>Creates a new NotificationConfiguration.</p>", + "documentation":"<p>Creates a new <code>NotificationConfiguration</code>.</p>", "idempotent":true }, "DeleteEventRule":{ @@ -92,7 +134,7 @@ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Deletes an EventRule.</p>", + "documentation":"<p>Deletes an <code>EventRule</code>.</p>", "idempotent":true }, "DeleteNotificationConfiguration":{ @@ -112,7 +154,7 @@ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Deletes a NotificationConfiguration.</p>", + "documentation":"<p>Deletes a <code>NotificationConfiguration</code>.</p>", "idempotent":true }, "DeregisterNotificationHub":{ @@ -132,7 +174,28 @@ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Deregisters a NotificationHub in the specified Region.</p> <note> <p>You can't deregister the last NotificationHub in the account. NotificationEvents stored in the deregistered NotificationHub are no longer be visible. Recreating a new NotificationHub in the same Region restores access to those NotificationEvents.</p> </note>", + "documentation":"<p>Deregisters a <code>NotificationConfiguration</code> in the specified Region.</p> <note> <p>You can't deregister the last <code>NotificationHub</code> in the account. <code>NotificationEvents</code> stored in the deregistered <code>NotificationConfiguration</code> are no longer be visible. Recreating a new <code>NotificationConfiguration</code> in the same Region restores access to those <code>NotificationEvents</code>.</p> </note>", + "idempotent":true + }, + "DisableNotificationsAccessForOrganization":{ + "name":"DisableNotificationsAccessForOrganization", + "http":{ + "method":"DELETE", + "requestUri":"/organization/access", + "responseCode":200 + }, + "input":{"shape":"DisableNotificationsAccessForOrganizationRequest"}, + "output":{"shape":"DisableNotificationsAccessForOrganizationResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Disables service trust between User Notifications and Amazon Web Services Organizations.</p>", "idempotent":true }, "DisassociateChannel":{ @@ -151,7 +214,67 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include AWS Chatbot, the AWS Console Mobile Application, and emails (notifications-contacts).</p>", + "documentation":"<p>Disassociates a Channel from a specified <code>NotificationConfiguration</code>. Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).</p>", + "idempotent":true + }, + "DisassociateManagedNotificationAccountContact":{ + "name":"DisassociateManagedNotificationAccountContact", + "http":{ + "method":"PUT", + "requestUri":"/contacts/disassociate-managed-notification/{contactIdentifier}", + "responseCode":200 + }, + "input":{"shape":"DisassociateManagedNotificationAccountContactRequest"}, + "output":{"shape":"DisassociateManagedNotificationAccountContactResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Disassociates an Account Contact with a particular <code>ManagedNotificationConfiguration</code>.</p>", + "idempotent":true + }, + "DisassociateManagedNotificationAdditionalChannel":{ + "name":"DisassociateManagedNotificationAdditionalChannel", + "http":{ + "method":"PUT", + "requestUri":"/channels/disassociate-managed-notification/{channelArn}", + "responseCode":200 + }, + "input":{"shape":"DisassociateManagedNotificationAdditionalChannelRequest"}, + "output":{"shape":"DisassociateManagedNotificationAdditionalChannelResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Disassociates an additional Channel from a particular <code>ManagedNotificationConfiguration</code>.</p> <p>Supported Channels include Chatbot, the Console Mobile Application, and emails (notifications-contacts).</p>", + "idempotent":true + }, + "EnableNotificationsAccessForOrganization":{ + "name":"EnableNotificationsAccessForOrganization", + "http":{ + "method":"POST", + "requestUri":"/organization/access", + "responseCode":200 + }, + "input":{"shape":"EnableNotificationsAccessForOrganizationRequest"}, + "output":{"shape":"EnableNotificationsAccessForOrganizationResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Enables service trust between User Notifications and Amazon Web Services Organizations.</p>", "idempotent":true }, "GetEventRule":{ @@ -170,7 +293,61 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Returns a specified EventRule.</p>" + "documentation":"<p>Returns a specified <code>EventRule</code>.</p>" + }, + "GetManagedNotificationChildEvent":{ + "name":"GetManagedNotificationChildEvent", + "http":{ + "method":"GET", + "requestUri":"/managed-notification-child-events/{arn}", + "responseCode":200 + }, + "input":{"shape":"GetManagedNotificationChildEventRequest"}, + "output":{"shape":"GetManagedNotificationChildEventResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Returns the child event of a specific given <code>ManagedNotificationEvent</code>.</p>" + }, + "GetManagedNotificationConfiguration":{ + "name":"GetManagedNotificationConfiguration", + "http":{ + "method":"GET", + "requestUri":"/managed-notification-configurations/{arn}", + "responseCode":200 + }, + "input":{"shape":"GetManagedNotificationConfigurationRequest"}, + "output":{"shape":"GetManagedNotificationConfigurationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Returns a specified <code>ManagedNotificationConfiguration</code>.</p>" + }, + "GetManagedNotificationEvent":{ + "name":"GetManagedNotificationEvent", + "http":{ + "method":"GET", + "requestUri":"/managed-notification-events/{arn}", + "responseCode":200 + }, + "input":{"shape":"GetManagedNotificationEventRequest"}, + "output":{"shape":"GetManagedNotificationEventResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Returns a specified <code>ManagedNotificationEvent</code>.</p>" }, "GetNotificationConfiguration":{ "name":"GetNotificationConfiguration", @@ -188,7 +365,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Returns a specified NotificationConfiguration.</p>" + "documentation":"<p>Returns a specified <code>NotificationConfiguration</code>.</p>" }, "GetNotificationEvent":{ "name":"GetNotificationEvent", @@ -206,7 +383,24 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Returns a specified NotificationEvent.</p> <important> <p>User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. GetNotificationEvent only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html\">Notification hubs</a> in the <i>AWS User Notifications User Guide</i>.</p> </important>" + "documentation":"<p>Returns a specified <code>NotificationEvent</code>.</p> <important> <p>User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. <code>GetNotificationEvent</code> only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html\">Notification hubs</a> in the <i>Amazon Web Services User Notifications User Guide</i>.</p> </important>" + }, + "GetNotificationsAccessForOrganization":{ + "name":"GetNotificationsAccessForOrganization", + "http":{ + "method":"GET", + "requestUri":"/organization/access", + "responseCode":200 + }, + "input":{"shape":"GetNotificationsAccessForOrganizationRequest"}, + "output":{"shape":"GetNotificationsAccessForOrganizationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Returns the AccessStatus of Service Trust Enablement for User Notifications and Amazon Web Services Organizations.</p>" }, "ListChannels":{ "name":"ListChannels", @@ -224,7 +418,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Returns a list of Channels for a NotificationConfiguration.</p>" + "documentation":"<p>Returns a list of Channels for a <code>NotificationConfiguration</code>.</p>" }, "ListEventRules":{ "name":"ListEventRules", @@ -242,7 +436,76 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).</p>" + "documentation":"<p>Returns a list of <code>EventRules</code> according to specified filters, in reverse chronological order (newest first).</p>" + }, + "ListManagedNotificationChannelAssociations":{ + "name":"ListManagedNotificationChannelAssociations", + "http":{ + "method":"GET", + "requestUri":"/channels/list-managed-notification-channel-associations", + "responseCode":200 + }, + "input":{"shape":"ListManagedNotificationChannelAssociationsRequest"}, + "output":{"shape":"ListManagedNotificationChannelAssociationsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Returns a list of Account contacts and Channels associated with a <code>ManagedNotificationConfiguration</code>, in paginated format.</p>" + }, + "ListManagedNotificationChildEvents":{ + "name":"ListManagedNotificationChildEvents", + "http":{ + "method":"GET", + "requestUri":"/list-managed-notification-child-events/{aggregateManagedNotificationEventArn}", + "responseCode":200 + }, + "input":{"shape":"ListManagedNotificationChildEventsRequest"}, + "output":{"shape":"ListManagedNotificationChildEventsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Returns a list of <code>ManagedNotificationChildEvents</code> for a specified aggregate <code>ManagedNotificationEvent</code>, ordered by creation time in reverse chronological order (newest first).</p>" + }, + "ListManagedNotificationConfigurations":{ + "name":"ListManagedNotificationConfigurations", + "http":{ + "method":"GET", + "requestUri":"/managed-notification-configurations", + "responseCode":200 + }, + "input":{"shape":"ListManagedNotificationConfigurationsRequest"}, + "output":{"shape":"ListManagedNotificationConfigurationsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Returns a list of Managed Notification Configurations according to specified filters, ordered by creation time in reverse chronological order (newest first).</p>" + }, + "ListManagedNotificationEvents":{ + "name":"ListManagedNotificationEvents", + "http":{ + "method":"GET", + "requestUri":"/managed-notification-events", + "responseCode":200 + }, + "input":{"shape":"ListManagedNotificationEventsRequest"}, + "output":{"shape":"ListManagedNotificationEventsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Returns a list of Managed Notification Events according to specified filters, ordered by creation time in reverse chronological order (newest first).</p>" }, "ListNotificationConfigurations":{ "name":"ListNotificationConfigurations", @@ -259,7 +522,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Returns a list of abbreviated NotificationConfigurations according to specified filters, in reverse chronological order (newest first).</p>" + "documentation":"<p>Returns a list of abbreviated <code>NotificationConfigurations</code> according to specified filters, in reverse chronological order (newest first).</p>" }, "ListNotificationEvents":{ "name":"ListNotificationEvents", @@ -276,7 +539,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Returns a list of NotificationEvents according to specified filters, in reverse chronological order (newest first).</p> <important> <p>User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html\">Notification hubs</a> in the <i>AWS User Notifications User Guide</i>.</p> </important>" + "documentation":"<p>Returns a list of <code>NotificationEvents</code> according to specified filters, in reverse chronological order (newest first).</p> <important> <p>User Notifications stores notifications in the individual Regions you register as notification hubs and the Region of the source event rule. ListNotificationEvents only returns notifications stored in the same Region in which the action is called. User Notifications doesn't backfill notifications to new Regions selected as notification hubs. For this reason, we recommend that you make calls in your oldest registered notification hub. For more information, see <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html\">Notification hubs</a> in the <i>Amazon Web Services User Notifications User Guide</i>.</p> </important>" }, "ListNotificationHubs":{ "name":"ListNotificationHubs", @@ -293,7 +556,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"<p>Returns a list of NotificationHubs.</p>" + "documentation":"<p>Returns a list of <code>NotificationHubs</code>.</p>" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -311,7 +574,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Returns a list of tags for a specified Amazon Resource Name (ARN).</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html\">Tagging your AWS resources</a> in the <i>Tagging AWS Resources User Guide</i>.</p> <note> <p>This is only supported for NotificationConfigurations.</p> </note>" + "documentation":"<p>Returns a list of tags for a specified Amazon Resource Name (ARN).</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html\">Tagging your Amazon Web Services resources</a> in the <i>Tagging Amazon Web Services Resources User Guide</i>.</p> <note> <p>This is only supported for <code>NotificationConfigurations</code>.</p> </note>" }, "RegisterNotificationHub":{ "name":"RegisterNotificationHub", @@ -330,7 +593,7 @@ {"shape":"ThrottlingException"}, {"shape":"ConflictException"} ], - "documentation":"<p>Registers a NotificationHub in the specified Region.</p> <p>There is a maximum of one NotificationHub per Region. You can have a maximum of 3 NotificationHubs at a time.</p>", + "documentation":"<p>Registers a <code>NotificationConfiguration</code> in the specified Region.</p> <p>There is a maximum of one <code>NotificationConfiguration</code> per Region. You can have a maximum of 3 <code>NotificationHub</code> resources at a time.</p>", "idempotent":true }, "TagResource":{ @@ -349,7 +612,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Tags the resource with a tag key and value.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html\">Tagging your AWS resources</a> in the <i>Tagging AWS Resources User Guide</i>.</p> <note> <p>This is only supported for NotificationConfigurations.</p> </note>", + "documentation":"<p>Tags the resource with a tag key and value.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html\">Tagging your Amazon Web Services resources</a> in the <i>Tagging Amazon Web Services Resources User Guide</i>.</p> <note> <p>This is only supported for <code>NotificationConfigurations</code>.</p> </note>", "idempotent":true }, "UntagResource":{ @@ -368,7 +631,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Untags a resource with a specified Amazon Resource Name (ARN).</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html\">Tagging your AWS resources</a> in the <i>Tagging AWS Resources User Guide</i>.</p>", + "documentation":"<p>Untags a resource with a specified Amazon Resource Name (ARN).</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html\">Tagging your Amazon Web Services resources</a> in the <i>Tagging Amazon Web Services Resources User Guide</i>.</p>", "idempotent":true }, "UpdateEventRule":{ @@ -388,7 +651,7 @@ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Updates an existing EventRule.</p>", + "documentation":"<p>Updates an existing <code>EventRule</code>.</p>", "idempotent":true }, "UpdateNotificationConfiguration":{ @@ -408,7 +671,7 @@ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Updates a NotificationConfiguration.</p>", + "documentation":"<p>Updates a <code>NotificationConfiguration</code>.</p>", "idempotent":true } }, @@ -426,10 +689,41 @@ }, "exception":true }, + "AccessStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED", + "PENDING" + ] + }, + "AccountContactType":{ + "type":"string", + "enum":[ + "ACCOUNT_PRIMARY", + "ACCOUNT_ALTERNATE_BILLING", + "ACCOUNT_ALTERNATE_OPERATIONS", + "ACCOUNT_ALTERNATE_SECURITY" + ] + }, "AccountId":{ "type":"string", "pattern":"\\d{12}" }, + "AggregatedNotificationRegions":{ + "type":"list", + "member":{"shape":"Region"} + }, + "AggregationDetail":{ + "type":"structure", + "members":{ + "summarizationDimensions":{ + "shape":"SummarizationDimensionDetails", + "documentation":"<p>Properties used to summarize aggregated events.</p>" + } + }, + "documentation":"<p>Provides detailed information about the dimensions used for aggregation.</p>" + }, "AggregationDuration":{ "type":"string", "enum":[ @@ -446,6 +740,64 @@ "NONE" ] }, + "AggregationKey":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"<p>Indicates the type of aggregation key.</p>" + }, + "value":{ + "shape":"String", + "documentation":"<p>Indicates the value associated with the aggregation key name.</p>" + } + }, + "documentation":"<p>Key-value collection that indicate how notifications are grouped.</p>" + }, + "AggregationKeys":{ + "type":"list", + "member":{"shape":"AggregationKey"} + }, + "AggregationSummary":{ + "type":"structure", + "required":[ + "eventCount", + "aggregatedBy", + "aggregatedAccounts", + "aggregatedRegions" + ], + "members":{ + "eventCount":{ + "shape":"Integer", + "documentation":"<p>Indicates the number of events associated with the aggregation key.</p>" + }, + "aggregatedBy":{ + "shape":"AggregationKeys", + "documentation":"<p>Indicates the criteria or rules by which notifications have been grouped together.</p>" + }, + "aggregatedAccounts":{ + "shape":"SummarizationDimensionOverview", + "documentation":"<p>Indicates the Amazon Web Services accounts in the aggregation key.</p>" + }, + "aggregatedRegions":{ + "shape":"SummarizationDimensionOverview", + "documentation":"<p>Indicates the Amazon Web Services Regions in the aggregation key.</p>" + }, + "aggregatedOrganizationalUnits":{ + "shape":"SummarizationDimensionOverview", + "documentation":"<p>Indicates the collection of organizational units that are involved in the aggregation key.</p>" + }, + "additionalSummarizationDimensions":{ + "shape":"SummarizationDimensionOverviews", + "documentation":"<p>List of additional dimensions used to group and summarize data.</p>" + } + }, + "documentation":"<p>Provides additional information about the aggregation key.</p>" + }, "Arn":{ "type":"string", "pattern":"arn:[^:]*:[^:]*:[^:]*:.*" @@ -459,13 +811,13 @@ "members":{ "arn":{ "shape":"ChannelArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the Channel to associate with the NotificationConfiguration.</p> <p>Supported ARNs include AWS Chatbot, the Console Mobile Application, and notifications-contacts.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the Channel to associate with the <code>NotificationConfiguration</code>.</p> <p>Supported ARNs include Chatbot, the Console Mobile Application, and notifications-contacts.</p>", "location":"uri", "locationName":"arn" }, "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The ARN of the NotificationConfiguration to associate with the Channel.</p>" + "documentation":"<p>The ARN of the <code>NotificationConfiguration</code> to associate with the Channel.</p>" } } }, @@ -474,6 +826,54 @@ "members":{ } }, + "AssociateManagedNotificationAccountContactRequest":{ + "type":"structure", + "required":[ + "contactIdentifier", + "managedNotificationConfigurationArn" + ], + "members":{ + "contactIdentifier":{ + "shape":"AccountContactType", + "documentation":"<p>A unique value of an Account Contact Type to associate with the <code>ManagedNotificationConfiguration</code>.</p>", + "location":"uri", + "locationName":"contactIdentifier" + }, + "managedNotificationConfigurationArn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> to associate with the Account Contact.</p>" + } + } + }, + "AssociateManagedNotificationAccountContactResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociateManagedNotificationAdditionalChannelRequest":{ + "type":"structure", + "required":[ + "channelArn", + "managedNotificationConfigurationArn" + ], + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the Channel to associate with the <code>ManagedNotificationConfiguration</code>.</p> <p>Supported ARNs include Chatbot, the Console Mobile Application, and email (notifications-contacts).</p>", + "location":"uri", + "locationName":"channelArn" + }, + "managedNotificationConfigurationArn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> to associate with the additional Channel.</p>" + } + } + }, + "AssociateManagedNotificationAdditionalChannelResponse":{ + "type":"structure", + "members":{ + } + }, "Boolean":{ "type":"boolean", "box":true @@ -482,6 +882,26 @@ "type":"string", "pattern":"arn:aws:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+" }, + "ChannelAssociationOverrideOption":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "ChannelIdentifier":{ + "type":"string", + "pattern":"ACCOUNT_PRIMARY|ACCOUNT_ALTERNATE_BILLING|ACCOUNT_ALTERNATE_OPERATIONS|ACCOUNT_ALTERNATE_SECURITY|arn:aws:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+" + }, + "ChannelType":{ + "type":"string", + "enum":[ + "MOBILE", + "CHATBOT", + "EMAIL", + "ACCOUNT_CONTACT" + ] + }, "Channels":{ "type":"list", "member":{"shape":"ChannelArn"} @@ -517,23 +937,23 @@ "members":{ "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the NotificationConfiguration associated with this EventRule.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code> associated with this <code>EventRule</code>.</p>" }, "source":{ "shape":"Source", - "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" + "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" }, "eventType":{ "shape":"EventType", - "documentation":"<p>The event type to match.</p> <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" + "documentation":"<p>The event type to match.</p> <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" }, "eventPattern":{ "shape":"EventRuleEventPattern", - "documentation":"<p>An additional event pattern used to further filter the events this EventRule receives.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html\">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i> </p>" + "documentation":"<p>An additional event pattern used to further filter the events this <code>EventRule</code> receives.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html\">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i> </p>" }, "regions":{ "shape":"Regions", - "documentation":"<p>A list of AWS Regions that send events to this EventRule.</p>" + "documentation":"<p>A list of Amazon Web Services Regions that send events to this <code>EventRule</code>.</p>" } } }, @@ -551,11 +971,11 @@ }, "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The ARN of a NotificationConfiguration.</p>" + "documentation":"<p>The ARN of a <code>NotificationConfiguration</code>.</p>" }, "statusSummaryByRegion":{ "shape":"StatusSummaryByRegion", - "documentation":"<p>A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.</p>" + "documentation":"<p>A list of an <code>EventRule</code>'s status by Region. Regions are mapped to <code>EventRuleStatusSummary</code>.</p>" } } }, @@ -568,15 +988,15 @@ "members":{ "name":{ "shape":"NotificationConfigurationName", - "documentation":"<p>The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.</p>" + "documentation":"<p>The name of the <code>NotificationConfiguration</code>. Supports RFC 3986's unreserved characters.</p>" }, "description":{ "shape":"NotificationConfigurationDescription", - "documentation":"<p>The description of the NotificationConfiguration.</p>" + "documentation":"<p>The description of the <code>NotificationConfiguration</code>.</p>" }, "aggregationDuration":{ "shape":"AggregationDuration", - "documentation":"<p>The aggregation preference of the NotificationConfiguration.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>LONG</code> </p> <ul> <li> <p>Aggregate notifications for long periods of time (12 hours).</p> </li> </ul> </li> <li> <p> <code>SHORT</code> </p> <ul> <li> <p>Aggregate notifications for short periods of time (5 minutes).</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>Don't aggregate notifications.</p> <p>No delay in delivery.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The aggregation preference of the <code>NotificationConfiguration</code>.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>LONG</code> </p> <ul> <li> <p>Aggregate notifications for long periods of time (12 hours).</p> </li> </ul> </li> <li> <p> <code>SHORT</code> </p> <ul> <li> <p>Aggregate notifications for short periods of time (5 minutes).</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>Don't aggregate notifications.</p> </li> </ul> </li> </ul> </li> </ul>" }, "tags":{ "shape":"TagMap", @@ -593,11 +1013,11 @@ "members":{ "arn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the the resource.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code>.</p>" }, "status":{ "shape":"NotificationConfigurationStatus", - "documentation":"<p>The status of this NotificationConfiguration.</p> <p>The status should always be <code>INACTIVE</code> when part of the CreateNotificationConfiguration response.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>PARTIALLY_ACTIVE</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p> </li> <li> <p>Any call can be run.</p> </li> </ul> </li> <li> <p> <code>INACTIVE</code> </p> <ul> <li> <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>DELETING</code> </p> <ul> <li> <p>This NotificationConfiguration is being deleted.</p> </li> <li> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The current status of this <code>NotificationConfiguration</code>.</p>" } } }, @@ -611,7 +1031,7 @@ "members":{ "arn":{ "shape":"EventRuleArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the EventRule to delete.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>EventRule</code> to delete.</p>", "location":"uri", "locationName":"arn" } @@ -628,7 +1048,7 @@ "members":{ "arn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the NotificationConfiguration to delete.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code> to delete.</p>", "location":"uri", "locationName":"arn" } @@ -645,7 +1065,7 @@ "members":{ "notificationHubRegion":{ "shape":"Region", - "documentation":"<p>The NotificationHub Region.</p>", + "documentation":"<p>The <code>NotificationConfiguration</code> Region.</p>", "location":"uri", "locationName":"notificationHubRegion" } @@ -660,11 +1080,11 @@ "members":{ "notificationHubRegion":{ "shape":"Region", - "documentation":"<p>The NotificationHub Region.</p>" + "documentation":"<p>The <code>NotificationConfiguration</code> Region.</p>" }, "statusSummary":{ "shape":"NotificationHubStatusSummary", - "documentation":"<p>NotificationHub status information.</p>" + "documentation":"<p> <code>NotificationConfiguration</code> status information.</p>" } } }, @@ -692,6 +1112,16 @@ "max":10, "min":0 }, + "DisableNotificationsAccessForOrganizationRequest":{ + "type":"structure", + "members":{ + } + }, + "DisableNotificationsAccessForOrganizationResponse":{ + "type":"structure", + "members":{ + } + }, "DisassociateChannelRequest":{ "type":"structure", "required":[ @@ -707,7 +1137,7 @@ }, "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The ARN of the NotificationConfiguration to disassociate.</p>" + "documentation":"<p>The ARN of the <code>NotificationConfiguration</code> to disassociate.</p>" } } }, @@ -716,6 +1146,64 @@ "members":{ } }, + "DisassociateManagedNotificationAccountContactRequest":{ + "type":"structure", + "required":[ + "contactIdentifier", + "managedNotificationConfigurationArn" + ], + "members":{ + "contactIdentifier":{ + "shape":"AccountContactType", + "documentation":"<p>The unique value of an Account Contact Type to associate with the <code>ManagedNotificationConfiguration</code>.</p>", + "location":"uri", + "locationName":"contactIdentifier" + }, + "managedNotificationConfigurationArn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> to associate with the Account Contact.</p>" + } + } + }, + "DisassociateManagedNotificationAccountContactResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateManagedNotificationAdditionalChannelRequest":{ + "type":"structure", + "required":[ + "channelArn", + "managedNotificationConfigurationArn" + ], + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the Channel to associate with the <code>ManagedNotificationConfiguration</code>.</p>", + "location":"uri", + "locationName":"channelArn" + }, + "managedNotificationConfigurationArn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the Managed Notification Configuration to associate with the additional Channel.</p>" + } + } + }, + "DisassociateManagedNotificationAdditionalChannelResponse":{ + "type":"structure", + "members":{ + } + }, + "EnableNotificationsAccessForOrganizationRequest":{ + "type":"structure", + "members":{ + } + }, + "EnableNotificationsAccessForOrganizationResponse":{ + "type":"structure", + "members":{ + } + }, "ErrorMessage":{"type":"string"}, "EventRuleArn":{ "type":"string", @@ -746,14 +1234,14 @@ "members":{ "status":{ "shape":"EventRuleStatus", - "documentation":"<p>The status of the EventRule.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>The EventRule can process events.</p> </li> </ul> </li> <li> <p> <code>INACTIVE</code> </p> <ul> <li> <p>The EventRule may be unable to process events.</p> </li> </ul> </li> <li> <p> <code>CREATING</code> </p> <ul> <li> <p>The EventRule is being created.</p> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> <li> <p> <code>UPDATING</code> </p> <ul> <li> <p>The EventRule is being updated.</p> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> <li> <p> <code>DELETING</code> </p> <ul> <li> <p>The EventRule is being deleted.</p> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The status of the <code>EventRule</code>.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>The <code>EventRule</code> can process events.</p> </li> </ul> </li> <li> <p> <code>INACTIVE</code> </p> <ul> <li> <p>The <code>EventRule</code> may be unable to process events.</p> </li> </ul> </li> <li> <p> <code>CREATING</code> </p> <ul> <li> <p>The <code>EventRule</code> is being created.</p> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> <li> <p> <code>UPDATING</code> </p> <ul> <li> <p>The <code>EventRule</code> is being updated.</p> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> <li> <p> <code>DELETING</code> </p> <ul> <li> <p>The <code>EventRule</code> is being deleted.</p> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> </ul> </li> </ul>" }, "reason":{ "shape":"EventRuleStatusReason", - "documentation":"<p>A human-readable reason for EventRuleStatus.</p>" + "documentation":"<p>A human-readable reason for <code>EventRuleStatus</code>.</p>" } }, - "documentation":"<p>Describes EventRule status information.</p>" + "documentation":"<p>Provides additional information about the current <code>EventRule</code> status.</p>" }, "EventRuleStructure":{ "type":"structure", @@ -771,42 +1259,42 @@ "members":{ "arn":{ "shape":"EventRuleArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>EventRule</code>. CloudFormation stack generates this ARN and then uses this ARN to associate with the <code>NotificationConfiguration</code>.</p>" }, "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The ARN for the NotificationConfiguration associated with this EventRule.</p>" + "documentation":"<p>The ARN for the <code>NotificationConfiguration</code> associated with this <code>EventRule</code>.</p>" }, "creationTime":{ "shape":"CreationTime", - "documentation":"<p>The creation time of the resource.</p>" + "documentation":"<p>The creation time of the <code>EventRule</code>.</p>" }, "source":{ "shape":"Source", - "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" + "documentation":"<p>The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i> Amazon EventBridge User Guide</i>.</p>" }, "eventType":{ "shape":"EventType", - "documentation":"<p>The event type to match.</p> <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" + "documentation":"<p>The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i> Amazon EventBridge User Guide</i>.</p>" }, "eventPattern":{ "shape":"EventRuleEventPattern", - "documentation":"<p>An additional event pattern used to further filter the events this EventRule receives.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html\">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i> </p>" + "documentation":"<p>An additional event pattern used to further filter the events this <code>EventRule</code> receives.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html\">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i> </p>" }, "regions":{ "shape":"Regions", - "documentation":"<p>A list of AWS Regions that send events to this EventRule.</p>" + "documentation":"<p>A list of Amazon Web Services Regions that send events to this <code>EventRule</code>.</p>" }, "managedRules":{ "shape":"ManagedRuleArns", - "documentation":"<p>A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.</p> <note> <p>These are created by AWS User Notifications within your account so your EventRules can function.</p> </note>" + "documentation":"<p>A list of Amazon EventBridge Managed Rule ARNs associated with this <code>EventRule</code>.</p> <note> <p>These are created by User Notifications within your account so your <code>EventRules</code> can function.</p> </note>" }, "statusSummaryByRegion":{ "shape":"StatusSummaryByRegion", - "documentation":"<p>A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.</p>" + "documentation":"<p>A list of an <code>EventRule</code>'s status by Region. Regions are mapped to <code>EventRuleStatusSummary</code>.</p>" } }, - "documentation":"<p>Contains a complete list of fields related to an EventRule.</p>" + "documentation":"<p>Contains a complete list of fields related to an <code>EventRule</code>.</p>" }, "EventRules":{ "type":"list", @@ -831,7 +1319,7 @@ "members":{ "arn":{ "shape":"EventRuleArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the EventRule to return.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>EventRule</code> to return.</p>", "location":"uri", "locationName":"arn" } @@ -857,35 +1345,169 @@ }, "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The ARN of a NotificationConfiguration.</p>" + "documentation":"<p>The ARN of a <code>NotificationConfiguration</code>.</p>" }, "creationTime":{ "shape":"CreationTime", - "documentation":"<p>The date when the EventRule was created.</p>" + "documentation":"<p>The date when the <code>EventRule</code> was created.</p>" }, "source":{ "shape":"Source", - "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" + "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" }, "eventType":{ "shape":"EventType", - "documentation":"<p>The event type to match.</p> <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" + "documentation":"<p>The event type to match.</p> <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" }, "eventPattern":{ "shape":"EventRuleEventPattern", - "documentation":"<p>An additional event pattern used to further filter the events this EventRule receives.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html\">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i> </p>" + "documentation":"<p>An additional event pattern used to further filter the events this <code>EventRule</code> receives.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html\">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i> </p>" }, "regions":{ "shape":"Regions", - "documentation":"<p>A list of AWS Regions that send events to this EventRule.</p>" + "documentation":"<p>A list of Amazon Web Services Regions that send events to this <code>EventRule</code>.</p>" }, "managedRules":{ "shape":"ManagedRuleArns", - "documentation":"<p>A list of managed rules from EventBridge that are are associated with this EventRule.</p> <note> <p>These are created by AWS User Notifications within your account so this EventRule functions.</p> </note>" + "documentation":"<p>A list of managed rules from EventBridge that are associated with this <code>EventRule</code>.</p> <note> <p>These are created by User Notifications within your account so this <code>EventRule</code> functions.</p> </note>" }, "statusSummaryByRegion":{ "shape":"StatusSummaryByRegion", - "documentation":"<p>A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.</p>" + "documentation":"<p>A list of an <code>EventRule</code>'s status by Region. Regions are mapped to <code>EventRuleStatusSummary</code>.</p>" + } + } + }, + "GetManagedNotificationChildEventRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"ManagedNotificationChildEventArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationChildEvent</code> to return.</p>", + "location":"uri", + "locationName":"arn" + }, + "locale":{ + "shape":"LocaleCode", + "documentation":"<p>The locale code of the language used for the retrieved <code>ManagedNotificationChildEvent</code>. The default locale is English <code>en_US</code>.</p>", + "location":"querystring", + "locationName":"locale" + } + } + }, + "GetManagedNotificationChildEventResponse":{ + "type":"structure", + "required":[ + "arn", + "managedNotificationConfigurationArn", + "creationTime", + "content" + ], + "members":{ + "arn":{ + "shape":"ManagedNotificationChildEventArn", + "documentation":"<p>The ARN of the resource.</p>" + }, + "managedNotificationConfigurationArn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> associated with the <code>ManagedNotificationChildEvent</code>.</p>" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"<p>The creation time of the <code>ManagedNotificationChildEvent</code>.</p>" + }, + "content":{ + "shape":"ManagedNotificationChildEvent", + "documentation":"<p>The content of the <code>ManagedNotificationChildEvent</code>.</p>" + } + } + }, + "GetManagedNotificationConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> to return.</p>", + "location":"uri", + "locationName":"arn" + } + } + }, + "GetManagedNotificationConfigurationResponse":{ + "type":"structure", + "required":[ + "arn", + "name", + "description", + "category", + "subCategory" + ], + "members":{ + "arn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The ARN of the <code>ManagedNotificationConfiguration</code> resource.</p>" + }, + "name":{ + "shape":"ManagedNotificationConfigurationName", + "documentation":"<p>The name of the <code>ManagedNotificationConfiguration</code>.</p>" + }, + "description":{ + "shape":"ManagedNotificationConfigurationDescription", + "documentation":"<p>The description of the <code>ManagedNotificationConfiguration</code>.</p>" + }, + "category":{ + "shape":"String", + "documentation":"<p>The category of the <code>ManagedNotificationConfiguration</code>.</p>" + }, + "subCategory":{ + "shape":"String", + "documentation":"<p>The subCategory of the <code>ManagedNotificationConfiguration</code>.</p>" + } + } + }, + "GetManagedNotificationEventRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"ManagedNotificationEventArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationEvent</code> to return.</p>", + "location":"uri", + "locationName":"arn" + }, + "locale":{ + "shape":"LocaleCode", + "documentation":"<p>The locale code of the language used for the retrieved <code>ManagedNotificationEvent</code>. The default locale is English <code>(en_US)</code>.</p>", + "location":"querystring", + "locationName":"locale" + } + } + }, + "GetManagedNotificationEventResponse":{ + "type":"structure", + "required":[ + "arn", + "managedNotificationConfigurationArn", + "creationTime", + "content" + ], + "members":{ + "arn":{ + "shape":"ManagedNotificationEventArn", + "documentation":"<p>The ARN of the resource.</p>" + }, + "managedNotificationConfigurationArn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The ARN of the <code>ManagedNotificationConfiguration</code>.</p>" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"<p>The creation time of the <code>ManagedNotificationEvent</code>.</p>" + }, + "content":{ + "shape":"ManagedNotificationEvent", + "documentation":"<p>The content of the <code>ManagedNotificationEvent</code>.</p>" } } }, @@ -895,7 +1517,7 @@ "members":{ "arn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the NotificationConfiguration to return.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code> to return.</p>", "location":"uri", "locationName":"arn" } @@ -917,23 +1539,23 @@ }, "name":{ "shape":"NotificationConfigurationName", - "documentation":"<p>The name of the NotificationConfiguration.</p>" + "documentation":"<p>The name of the <code>NotificationConfiguration</code>.</p>" }, "description":{ "shape":"NotificationConfigurationDescription", - "documentation":"<p>The description of the NotificationConfiguration.</p>" + "documentation":"<p>The description of the <code>NotificationConfiguration</code>.</p>" }, "status":{ "shape":"NotificationConfigurationStatus", - "documentation":"<p>The status of this NotificationConfiguration.</p> <p>The status should always be <code>INACTIVE</code> when part of the CreateNotificationConfiguration response.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>PARTIALLY_ACTIVE</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p> </li> <li> <p>Any call can be run.</p> </li> </ul> </li> <li> <p> <code>INACTIVE</code> </p> <ul> <li> <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>DELETING</code> </p> <ul> <li> <p>This NotificationConfiguration is being deleted. Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> <li> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The status of this <code>NotificationConfiguration</code>.</p>" }, "creationTime":{ "shape":"CreationTime", - "documentation":"<p>The creation time of the NotificationConfiguration.</p>" + "documentation":"<p>The creation time of the <code>NotificationConfiguration</code>.</p>" }, "aggregationDuration":{ "shape":"AggregationDuration", - "documentation":"<p>The aggregation preference of the NotificationConfiguration.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>LONG</code> </p> <ul> <li> <p>Aggregate notifications for long periods of time (12 hours).</p> </li> </ul> </li> <li> <p> <code>SHORT</code> </p> <ul> <li> <p>Aggregate notifications for short periods of time (5 minutes).</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>Don't aggregate notifications.</p> <p>No delay in delivery.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The aggregation preference of the <code>NotificationConfiguration</code>.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>LONG</code> </p> <ul> <li> <p>Aggregate notifications for long periods of time (12 hours).</p> </li> </ul> </li> <li> <p> <code>SHORT</code> </p> <ul> <li> <p>Aggregate notifications for short periods of time (5 minutes).</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>Don't aggregate notifications.</p> </li> </ul> </li> </ul> </li> </ul>" } } }, @@ -943,13 +1565,13 @@ "members":{ "arn":{ "shape":"NotificationEventArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the NotificationEvent to return.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>NotificationEvent</code> to return.</p>", "location":"uri", "locationName":"arn" }, "locale":{ "shape":"LocaleCode", - "documentation":"<p>The locale code of the language used for the retrieved NotificationEvent. The default locale is English <code>en_US</code>.</p>", + "documentation":"<p>The locale code of the language used for the retrieved <code>NotificationEvent</code>. The default locale is English <code>en_US</code>.</p>", "location":"querystring", "locationName":"locale" } @@ -970,15 +1592,30 @@ }, "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The ARN of the NotificationConfiguration.</p>" + "documentation":"<p>The ARN of the <code>NotificationConfiguration</code>.</p>" }, "creationTime":{ "shape":"CreationTime", - "documentation":"<p>The creation time of the NotificationEvent.</p>" + "documentation":"<p>The creation time of the <code>NotificationEvent</code>.</p>" }, "content":{ "shape":"NotificationEvent", - "documentation":"<p>The content of the NotificationEvent.</p>" + "documentation":"<p>The content of the <code>NotificationEvent</code>.</p>" + } + } + }, + "GetNotificationsAccessForOrganizationRequest":{ + "type":"structure", + "members":{ + } + }, + "GetNotificationsAccessForOrganizationResponse":{ + "type":"structure", + "required":["notificationsAccessForOrganization"], + "members":{ + "notificationsAccessForOrganization":{ + "shape":"NotificationsAccessForOrganization", + "documentation":"<p>The <code>AccessStatus</code> of Service Trust Enablement for User Notifications to Amazon Web Services Organizations.</p>" } } }, @@ -1008,7 +1645,7 @@ "members":{ "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the NotificationConfiguration.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code>.</p>", "location":"querystring", "locationName":"notificationConfigurationArn" }, @@ -1020,7 +1657,7 @@ }, "nextToken":{ "shape":"NextToken", - "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. NextToken uses Base64 encoding.</p>", + "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. <code>NextToken</code> uses Base64 encoding.</p>", "location":"querystring", "locationName":"nextToken" } @@ -1052,7 +1689,7 @@ "members":{ "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the NotificationConfiguration.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code>.</p>", "location":"querystring", "locationName":"notificationConfigurationArn" }, @@ -1064,7 +1701,7 @@ }, "nextToken":{ "shape":"NextToken", - "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.</p>", + "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous <code>ListEventRules</code> call. Next token uses Base64 encoding.</p>", "location":"querystring", "locationName":"nextToken" } @@ -1086,7 +1723,241 @@ }, "eventRules":{ "shape":"EventRules", - "documentation":"<p>A list of EventRules.</p>" + "documentation":"<p>A list of <code>EventRules</code>.</p>" + } + } + }, + "ListManagedNotificationChannelAssociationsRequest":{ + "type":"structure", + "required":["managedNotificationConfigurationArn"], + "members":{ + "managedNotificationConfigurationArn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code> to match.</p>", + "location":"querystring", + "locationName":"managedNotificationConfigurationArn" + }, + "maxResults":{ + "shape":"ListManagedNotificationChannelAssociationsRequestMaxResultsInteger", + "documentation":"<p>The maximum number of results to be returned in this call. Defaults to 20.</p>", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous <code>ListManagedNotificationChannelAssociations</code> call.</p>", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListManagedNotificationChannelAssociationsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListManagedNotificationChannelAssociationsResponse":{ + "type":"structure", + "required":["channelAssociations"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>" + }, + "channelAssociations":{ + "shape":"ManagedNotificationChannelAssociations", + "documentation":"<p>A list that contains the following information about a channel association.</p>" + } + } + }, + "ListManagedNotificationChildEventsRequest":{ + "type":"structure", + "required":["aggregateManagedNotificationEventArn"], + "members":{ + "aggregateManagedNotificationEventArn":{ + "shape":"ManagedNotificationEventArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationEvent</code>.</p>", + "location":"uri", + "locationName":"aggregateManagedNotificationEventArn" + }, + "startTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"<p>The earliest time of events to return from this call.</p>", + "location":"querystring", + "locationName":"startTime" + }, + "endTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"<p>Latest time of events to return from this call.</p>", + "location":"querystring", + "locationName":"endTime" + }, + "locale":{ + "shape":"LocaleCode", + "documentation":"<p>The locale code of the language used for the retrieved <code>NotificationEvent</code>. The default locale is English.<code>en_US</code>.</p>", + "location":"querystring", + "locationName":"locale" + }, + "maxResults":{ + "shape":"ListManagedNotificationChildEventsRequestMaxResultsInteger", + "documentation":"<p>The maximum number of results to be returned in this call. Defaults to 20.</p>", + "location":"querystring", + "locationName":"maxResults" + }, + "relatedAccount":{ + "shape":"AccountId", + "documentation":"<p>The Amazon Web Services account ID associated with the Managed Notification Child Events.</p>", + "location":"querystring", + "locationName":"relatedAccount" + }, + "organizationalUnitId":{ + "shape":"OrganizationalUnitId", + "documentation":"<p>The identifier of the Amazon Web Services Organizations organizational unit (OU) associated with the Managed Notification Child Events.</p>", + "location":"querystring", + "locationName":"organizationalUnitId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.</p>", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListManagedNotificationChildEventsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListManagedNotificationChildEventsResponse":{ + "type":"structure", + "required":["managedNotificationChildEvents"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>" + }, + "managedNotificationChildEvents":{ + "shape":"ManagedNotificationChildEvents", + "documentation":"<p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>" + } + } + }, + "ListManagedNotificationConfigurationsRequest":{ + "type":"structure", + "members":{ + "channelIdentifier":{ + "shape":"ChannelIdentifier", + "documentation":"<p>The identifier or ARN of the notification channel to filter configurations by.</p>", + "location":"querystring", + "locationName":"channelIdentifier" + }, + "maxResults":{ + "shape":"ListManagedNotificationConfigurationsRequestMaxResultsInteger", + "documentation":"<p>The maximum number of results to be returned in this call. Defaults to 20.</p>", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous ListManagedNotificationChannelAssociations call. Next token uses Base64 encoding.</p>", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListManagedNotificationConfigurationsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListManagedNotificationConfigurationsResponse":{ + "type":"structure", + "required":["managedNotificationConfigurations"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>" + }, + "managedNotificationConfigurations":{ + "shape":"ManagedNotificationConfigurations", + "documentation":"<p>A list of Managed Notification Configurations matching the request criteria.</p>" + } + } + }, + "ListManagedNotificationEventsRequest":{ + "type":"structure", + "members":{ + "startTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"<p>The earliest time of events to return from this call.</p>", + "location":"querystring", + "locationName":"startTime" + }, + "endTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"<p>Latest time of events to return from this call.</p>", + "location":"querystring", + "locationName":"endTime" + }, + "locale":{ + "shape":"LocaleCode", + "documentation":"<p>The locale code of the language used for the retrieved NotificationEvent. The default locale is English (en_US).</p>", + "location":"querystring", + "locationName":"locale" + }, + "source":{ + "shape":"Source", + "documentation":"<p>The Amazon Web Services service the event originates from. For example aws.cloudwatch.</p>", + "location":"querystring", + "locationName":"source" + }, + "maxResults":{ + "shape":"ListManagedNotificationEventsRequestMaxResultsInteger", + "documentation":"<p>The maximum number of results to be returned in this call. Defaults to 20.</p>", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous <code>ListManagedNotificationChannelAssociations</code> call. Next token uses Base64 encoding.</p>", + "location":"querystring", + "locationName":"nextToken" + }, + "organizationalUnitId":{ + "shape":"OrganizationalUnitId", + "documentation":"<p>The Organizational Unit Id that an Amazon Web Services account belongs to.</p>", + "location":"querystring", + "locationName":"organizationalUnitId" + }, + "relatedAccount":{ + "shape":"AccountId", + "documentation":"<p>The Amazon Web Services account ID associated with the Managed Notification Events.</p>", + "location":"querystring", + "locationName":"relatedAccount" + } + } + }, + "ListManagedNotificationEventsRequestMaxResultsInteger":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListManagedNotificationEventsResponse":{ + "type":"structure", + "required":["managedNotificationEvents"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.</p>" + }, + "managedNotificationEvents":{ + "shape":"ManagedNotificationEvents", + "documentation":"<p>A list of Managed Notification Events matching the request criteria.</p>" } } }, @@ -1095,7 +1966,7 @@ "members":{ "eventRuleSource":{ "shape":"Source", - "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>", + "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>", "location":"querystring", "locationName":"eventRuleSource" }, @@ -1107,7 +1978,7 @@ }, "status":{ "shape":"NotificationConfigurationStatus", - "documentation":"<p>The NotificationConfiguration status to match.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>PARTIALLY_ACTIVE</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> <li> <p>Any call can be run.</p> </li> </ul> </li> <li> <p> <code>INACTIVE</code> </p> <ul> <li> <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>DELETING</code> </p> <ul> <li> <p>This NotificationConfiguration is being deleted.</p> </li> <li> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> </ul> </li> </ul>", + "documentation":"<p>The <code>NotificationConfiguration</code> status to match.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>All <code>EventRules</code> are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>PARTIALLY_ACTIVE</code> </p> <ul> <li> <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> <li> <p>Any call can be run.</p> </li> </ul> </li> <li> <p> <code>INACTIVE</code> </p> <ul> <li> <p>All <code>EventRules</code> are <code>INACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>DELETING</code> </p> <ul> <li> <p>This <code>NotificationConfiguration</code> is being deleted.</p> </li> <li> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> </ul> </li> </ul>", "location":"querystring", "locationName":"status" }, @@ -1119,7 +1990,7 @@ }, "nextToken":{ "shape":"NextToken", - "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.</p>", + "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous <code>ListEventRules</code> call. Next token uses Base64 encoding.</p>", "location":"querystring", "locationName":"nextToken" } @@ -1141,7 +2012,7 @@ }, "notificationConfigurations":{ "shape":"NotificationConfigurations", - "documentation":"<p>The NotificationConfigurations in the account.</p>" + "documentation":"<p>The <code>NotificationConfigurations</code> in the account.</p>" } } }, @@ -1162,13 +2033,13 @@ }, "locale":{ "shape":"LocaleCode", - "documentation":"<p>The locale code of the language used for the retrieved NotificationEvent. The default locale is English <code>(en_US)</code>.</p>", + "documentation":"<p>The locale code of the language used for the retrieved <code>NotificationEvent</code>. The default locale is English <code>(en_US)</code>.</p>", "location":"querystring", "locationName":"locale" }, "source":{ "shape":"Source", - "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>", + "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>", "location":"querystring", "locationName":"source" }, @@ -1180,7 +2051,7 @@ }, "aggregateNotificationEventArn":{ "shape":"NotificationEventArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the aggregatedNotificationEventArn to match.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>aggregatedNotificationEventArn</code> to match.</p>", "location":"querystring", "locationName":"aggregateNotificationEventArn" }, @@ -1192,7 +2063,7 @@ }, "nextToken":{ "shape":"NextToken", - "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.</p>", + "documentation":"<p>The start token for paginated calls. Retrieved from the response of a previous <code>ListEventRules</code> call. Next token uses Base64 encoding.</p>", "location":"querystring", "locationName":"nextToken" } @@ -1247,7 +2118,7 @@ "members":{ "notificationHubs":{ "shape":"NotificationHubs", - "documentation":"<p>The NotificationHubs in the account.</p>" + "documentation":"<p>The <code>NotificationHubs</code> in the account.</p>" }, "nextToken":{ "shape":"NextToken", @@ -1296,6 +2167,363 @@ "zh_TW" ] }, + "ManagedNotificationChannelAssociationSummary":{ + "type":"structure", + "required":[ + "channelIdentifier", + "channelType" + ], + "members":{ + "channelIdentifier":{ + "shape":"String", + "documentation":"<p>The unique identifier for the notification channel.</p>" + }, + "channelType":{ + "shape":"ChannelType", + "documentation":"<p>The type of notification channel used for message delivery.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACCOUNT_CONTACT</code> </p> <ul> <li> <p>Delivers notifications to Account Managed contacts through the User Notification Service.</p> </li> </ul> </li> <li> <p> <code>MOBILE</code> </p> <ul> <li> <p>Delivers notifications through the Amazon Web Services Console Mobile Application to mobile devices.</p> </li> </ul> </li> <li> <p> <code>CHATBOT</code> </p> <ul> <li> <p>Delivers notifications through Chatbot to collaboration platforms (Slack, Chime).</p> </li> </ul> </li> <li> <p> <code>EMAIL</code> </p> <ul> <li> <p>Delivers notifications to email addresses.</p> </li> </ul> </li> </ul> </li> </ul>" + }, + "overrideOption":{ + "shape":"ChannelAssociationOverrideOption", + "documentation":"<p>Controls whether users can modify channel associations for a notification configuration.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ENABLED</code> </p> <ul> <li> <p>Users can associate or disassociate channels with the notification configuration.</p> </li> </ul> </li> <li> <p> <code>DISABLED</code> </p> <ul> <li> <p>Users cannot associate or disassociate channels with the notification configuration.</p> </li> </ul> </li> </ul> </li> </ul>" + } + }, + "documentation":"<p>Provides a summary of channel associations for a managed notification configuration.</p>" + }, + "ManagedNotificationChannelAssociations":{ + "type":"list", + "member":{"shape":"ManagedNotificationChannelAssociationSummary"} + }, + "ManagedNotificationChildEvent":{ + "type":"structure", + "required":[ + "schemaVersion", + "id", + "messageComponents", + "notificationType", + "aggregateManagedNotificationEventArn", + "textParts" + ], + "members":{ + "schemaVersion":{ + "shape":"SchemaVersion", + "documentation":"<p>The schema version of the Managed Notification Child Event.</p>" + }, + "id":{ + "shape":"NotificationEventId", + "documentation":"<p>The unique identifier for a Managed Notification Child Event.</p>" + }, + "messageComponents":{"shape":"MessageComponents"}, + "sourceEventDetailUrl":{ + "shape":"Url", + "documentation":"<p>The source event URL.</p>" + }, + "sourceEventDetailUrlDisplayText":{ + "shape":"String", + "documentation":"<p>The detailed URL for the source event.</p>" + }, + "notificationType":{ + "shape":"NotificationType", + "documentation":"<p>The type of event causing the notification.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ALERT</code> </p> <ul> <li> <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p> </li> </ul> </li> <li> <p> <code>WARNING</code> </p> <ul> <li> <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p> </li> </ul> </li> <li> <p> <code>ANNOUNCEMENT</code> </p> <ul> <li> <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p> </li> </ul> </li> <li> <p> <code>INFORMATIONAL</code> </p> <ul> <li> <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p> </li> </ul> </li> </ul> </li> </ul>" + }, + "eventStatus":{ + "shape":"EventStatus", + "documentation":"<p>The assesed nature of the event.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>HEALTHY</code> </p> <ul> <li> <p>All <code>EventRules</code> are <code>ACTIVE</code>.</p> </li> </ul> </li> <li> <p> <code>UNHEALTHY</code> </p> <ul> <li> <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p> </li> </ul> </li> </ul> </li> </ul>" + }, + "aggregateManagedNotificationEventArn":{ + "shape":"ManagedNotificationEventArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this Managed Notification Child Event.</p>" + }, + "startTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"<p>The notification event start time.</p>" + }, + "endTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"<p>The end time of the event.</p>" + }, + "textParts":{ + "shape":"TextParts", + "documentation":"<p>A list of text values.</p>" + }, + "organizationalUnitId":{ + "shape":"OrganizationalUnitId", + "documentation":"<p>The Organizational Unit Id that an Amazon Web Services account belongs to.</p>" + }, + "aggregationDetail":{ + "shape":"AggregationDetail", + "documentation":"<p>Provides detailed information about the dimensions used for event summarization and aggregation.</p>" + } + }, + "documentation":"<p>A ManagedNotificationChildEvent is a notification-focused representation of an event. They contain semantic information used to create aggregated or non-aggregated end-user notifications.</p>" + }, + "ManagedNotificationChildEventArn":{ + "type":"string", + "pattern":"arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9\\-]{3,64}/sub-category/[a-zA-Z0-9\\-]{3,64}/event/[a-z0-9]{27}/child-event/[a-z0-9]{27}" + }, + "ManagedNotificationChildEventOverview":{ + "type":"structure", + "required":[ + "arn", + "managedNotificationConfigurationArn", + "relatedAccount", + "creationTime", + "childEvent", + "aggregateManagedNotificationEventArn" + ], + "members":{ + "arn":{ + "shape":"ManagedNotificationEventArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationChildEvent</code>.</p>" + }, + "managedNotificationConfigurationArn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code>.</p>" + }, + "relatedAccount":{ + "shape":"AccountId", + "documentation":"<p>The account that related to the <code>ManagedNotificationChildEvent</code>.</p>" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"<p>The creation time of the <code>ManagedNotificationChildEvent</code>.</p>" + }, + "childEvent":{ + "shape":"ManagedNotificationChildEventSummary", + "documentation":"<p>The content of the <code>ManagedNotificationChildEvent</code>.</p>" + }, + "aggregateManagedNotificationEventArn":{ + "shape":"ManagedNotificationEventArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this <code>ManagedNotificationChildEvent</code>.</p>" + }, + "organizationalUnitId":{ + "shape":"OrganizationalUnitId", + "documentation":"<p>The Organizational Unit Id that an AWS account belongs to.</p>" + } + }, + "documentation":"<p>Describes an overview and metadata for a <code>ManagedNotificationChildEvent</code>.</p>" + }, + "ManagedNotificationChildEventSummary":{ + "type":"structure", + "required":[ + "schemaVersion", + "sourceEventMetadata", + "messageComponents", + "aggregationDetail", + "eventStatus", + "notificationType" + ], + "members":{ + "schemaVersion":{ + "shape":"SchemaVersion", + "documentation":"<p>The schema version of the <code>ManagedNotificationChildEvent</code>.</p>" + }, + "sourceEventMetadata":{ + "shape":"ManagedSourceEventMetadataSummary", + "documentation":"<p>Contains all event metadata present identically across all <code>NotificationEvents</code>. All fields are present in Source Events via Eventbridge.</p>" + }, + "messageComponents":{"shape":"MessageComponentsSummary"}, + "aggregationDetail":{ + "shape":"AggregationDetail", + "documentation":"<p>Provides detailed information about the dimensions used for event summarization and aggregation.</p>" + }, + "eventStatus":{ + "shape":"EventStatus", + "documentation":"<p>The perceived nature of the event.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>HEALTHY</code> </p> <ul> <li> <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>UNHEALTHY</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> </ul> </li> </ul>" + }, + "notificationType":{ + "shape":"NotificationType", + "documentation":"<p>The Type of the event causing this notification.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ALERT</code> </p> <ul> <li> <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p> </li> </ul> </li> <li> <p> <code>WARNING</code> </p> <ul> <li> <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p> </li> </ul> </li> <li> <p> <code>ANNOUNCEMENT</code> </p> <ul> <li> <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p> </li> </ul> </li> <li> <p> <code>INFORMATIONAL</code> </p> <ul> <li> <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p> </li> </ul> </li> </ul> </li> </ul>" + } + }, + "documentation":"<p>Describes a short summary and metadata for a <code>ManagedNotificationChildEvent</code>.</p>" + }, + "ManagedNotificationChildEvents":{ + "type":"list", + "member":{"shape":"ManagedNotificationChildEventOverview"} + }, + "ManagedNotificationConfigurationDescription":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[^\\u0001-\\u001F\\u007F-\\u009F]*" + }, + "ManagedNotificationConfigurationName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9\\-]+" + }, + "ManagedNotificationConfigurationOsArn":{ + "type":"string", + "pattern":"arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9\\-]{3,64}/sub-category/[a-zA-Z0-9\\-]{3,64}" + }, + "ManagedNotificationConfigurationStructure":{ + "type":"structure", + "required":[ + "arn", + "name", + "description" + ], + "members":{ + "arn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code>.</p>" + }, + "name":{ + "shape":"ManagedNotificationConfigurationName", + "documentation":"<p>The name of the <code>ManagedNotificationConfiguration</code>.</p>" + }, + "description":{ + "shape":"ManagedNotificationConfigurationDescription", + "documentation":"<p>The description of the <code>ManagedNotificationConfiguration</code>.</p>" + } + }, + "documentation":"<p>Describes the basic structure and properties of a <code>ManagedNotificationConfiguration</code>.</p>" + }, + "ManagedNotificationConfigurations":{ + "type":"list", + "member":{"shape":"ManagedNotificationConfigurationStructure"} + }, + "ManagedNotificationEvent":{ + "type":"structure", + "required":[ + "schemaVersion", + "id", + "messageComponents", + "notificationType", + "textParts" + ], + "members":{ + "schemaVersion":{ + "shape":"SchemaVersion", + "documentation":"<p>Version of the <code>ManagedNotificationEvent</code> schema.</p>" + }, + "id":{ + "shape":"NotificationEventId", + "documentation":"<p>Unique identifier for a <code>ManagedNotificationEvent</code>.</p>" + }, + "messageComponents":{"shape":"MessageComponents"}, + "sourceEventDetailUrl":{ + "shape":"Url", + "documentation":"<p>URL defined by Source Service to be used by notification consumers to get additional information about event.</p>" + }, + "sourceEventDetailUrlDisplayText":{ + "shape":"String", + "documentation":"<p>Text that needs to be hyperlinked with the sourceEventDetailUrl. For example, the description of the sourceEventDetailUrl.</p>" + }, + "notificationType":{ + "shape":"NotificationType", + "documentation":"<p>The nature of the event causing this notification.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ALERT</code> </p> <ul> <li> <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p> </li> </ul> </li> <li> <p> <code>WARNING</code> </p> <ul> <li> <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p> </li> </ul> </li> <li> <p> <code>ANNOUNCEMENT</code> </p> <ul> <li> <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p> </li> </ul> </li> <li> <p> <code>INFORMATIONAL</code> </p> <ul> <li> <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p> </li> </ul> </li> </ul> </li> </ul>" + }, + "eventStatus":{ + "shape":"EventStatus", + "documentation":"<p>The status of an event.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>HEALTHY</code> </p> <ul> <li> <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>UNHEALTHY</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> </ul> </li> </ul>" + }, + "aggregationEventType":{ + "shape":"AggregationEventType", + "documentation":"<p>The notifications aggregation type.</p>" + }, + "aggregationSummary":{"shape":"AggregationSummary"}, + "startTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"<p>The earliest time of events to return from this call.</p>" + }, + "endTime":{ + "shape":"SyntheticTimestamp_date_time", + "documentation":"<p>The end time of the notification event.</p>" + }, + "textParts":{ + "shape":"TextParts", + "documentation":"<p>A list of text values.</p>" + }, + "organizationalUnitId":{ + "shape":"OrganizationalUnitId", + "documentation":"<p>The Organizational Unit Id that an Amazon Web Services account belongs to.</p>" + } + }, + "documentation":"<p>A notification-focused representation of an event. They contain semantic information used by AccountContacts or Additional Channels to create end-user notifications.</p>" + }, + "ManagedNotificationEventArn":{ + "type":"string", + "pattern":"arn:[-.a-z0-9]{1,63}:notifications::[0-9]{12}:managed-notification-configuration/category/[a-zA-Z0-9\\-]{3,64}/sub-category/[a-zA-Z0-9\\-]{3,64}/event/[a-z0-9]{27}" + }, + "ManagedNotificationEventOverview":{ + "type":"structure", + "required":[ + "arn", + "managedNotificationConfigurationArn", + "relatedAccount", + "creationTime", + "notificationEvent" + ], + "members":{ + "arn":{ + "shape":"ManagedNotificationEventArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the ManagedNotificationEvent.</p>" + }, + "managedNotificationConfigurationArn":{ + "shape":"ManagedNotificationConfigurationOsArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>ManagedNotificationConfiguration</code>.</p>" + }, + "relatedAccount":{ + "shape":"AccountId", + "documentation":"<p>The account that related to the <code>ManagedNotificationEvent</code>.</p>" + }, + "creationTime":{ + "shape":"CreationTime", + "documentation":"<p>The creation time of the <code>ManagedNotificationEvent</code>.</p>" + }, + "notificationEvent":{"shape":"ManagedNotificationEventSummary"}, + "aggregationEventType":{ + "shape":"AggregationEventType", + "documentation":"<p>The notifications aggregation type.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>AGGREGATE</code> </p> <ul> <li> <p>The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.</p> </li> </ul> </li> <li> <p> <code>CHILD</code> </p> <ul> <li> <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>The notification isn't aggregated.</p> </li> </ul> </li> </ul> </li> </ul>" + }, + "organizationalUnitId":{ + "shape":"OrganizationalUnitId", + "documentation":"<p>The Organizational Unit Id that an Amazon Web Services account belongs to.</p>" + }, + "aggregationSummary":{"shape":"AggregationSummary"}, + "aggregatedNotificationRegions":{ + "shape":"AggregatedNotificationRegions", + "documentation":"<p>The list of the regions where the aggregated notifications in this <code>NotificationEvent</code> originated.</p>" + } + }, + "documentation":"<p>Describes an overview and metadata for a ManagedNotificationEvent.</p>" + }, + "ManagedNotificationEventSummary":{ + "type":"structure", + "required":[ + "schemaVersion", + "sourceEventMetadata", + "messageComponents", + "eventStatus", + "notificationType" + ], + "members":{ + "schemaVersion":{ + "shape":"SchemaVersion", + "documentation":"<p>The schema version of the <code>ManagedNotificationEvent</code>.</p>" + }, + "sourceEventMetadata":{ + "shape":"ManagedSourceEventMetadataSummary", + "documentation":"<p>Contains metadata about the event that caused the <code>ManagedNotificationEvent</code>.</p>" + }, + "messageComponents":{"shape":"MessageComponentsSummary"}, + "eventStatus":{ + "shape":"EventStatus", + "documentation":"<p>The managed notification event status.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>HEALTHY</code> </p> <ul> <li> <p>All <code>EventRules</code> are <code>ACTIVE</code>.</p> </li> </ul> </li> <li> <p> <code>UNHEALTHY</code> </p> <ul> <li> <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p> </li> </ul> </li> </ul> </li> </ul>" + }, + "notificationType":{ + "shape":"NotificationType", + "documentation":"<p>The Type of event causing the notification.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ALERT</code> </p> <ul> <li> <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p> </li> </ul> </li> <li> <p> <code>WARNING</code> </p> <ul> <li> <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p> </li> </ul> </li> <li> <p> <code>ANNOUNCEMENT</code> </p> <ul> <li> <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p> </li> </ul> </li> <li> <p> <code>INFORMATIONAL</code> </p> <ul> <li> <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p> </li> </ul> </li> </ul> </li> </ul>" + } + }, + "documentation":"<p>A short summary of a <code>ManagedNotificationEvent</code>. This is only used when listing managed notification events.</p>" + }, + "ManagedNotificationEvents":{ + "type":"list", + "member":{"shape":"ManagedNotificationEventOverview"} + }, "ManagedRuleArn":{ "type":"string", "pattern":"arn:aws:events:[a-z-\\d]{2,25}:\\d{12}:rule\\/[a-zA-Z-\\d]{1,1024}" @@ -1304,6 +2532,40 @@ "type":"list", "member":{"shape":"ManagedRuleArn"} }, + "ManagedSourceEventMetadataSummary":{ + "type":"structure", + "required":[ + "source", + "eventType" + ], + "members":{ + "eventOriginRegion":{ + "shape":"ManagedSourceEventMetadataSummaryEventOriginRegionString", + "documentation":"<p>The Region where the notification originated.</p>" + }, + "source":{ + "shape":"Source", + "documentation":"<p>The source service of the notification.</p> <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" + }, + "eventType":{ + "shape":"ManagedSourceEventMetadataSummaryEventTypeString", + "documentation":"<p>The event Type of the notification.</p>" + } + }, + "documentation":"<p>A short summary and metadata for a managed notification event.</p>" + }, + "ManagedSourceEventMetadataSummaryEventOriginRegionString":{ + "type":"string", + "max":32, + "min":0, + "pattern":"([a-z]{1,2})-([a-z]{1,15}-)+([0-9])" + }, + "ManagedSourceEventMetadataSummaryEventTypeString":{ + "type":"string", + "max":256, + "min":1, + "pattern":"([a-zA-Z0-9 \\-\\(\\)])+" + }, "Media":{ "type":"list", "member":{"shape":"MediaElement"} @@ -1327,7 +2589,7 @@ }, "url":{ "shape":"Url", - "documentation":"<p>The url of the media.</p>" + "documentation":"<p>The URL of the media.</p>" }, "caption":{ "shape":"TextPartReference", @@ -1354,7 +2616,7 @@ }, "paragraphSummary":{ "shape":"TextPartReference", - "documentation":"<p>A paragraph long or multiple sentence summary. For example, AWS Chatbot notifications.</p>" + "documentation":"<p>A paragraph long or multiple sentence summary. For example, Chatbot notifications.</p>" }, "completeDescription":{ "shape":"TextPartReference", @@ -1426,27 +2688,27 @@ "members":{ "arn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the <code>NotificationConfiguration</code> resource.</p>" }, "name":{ "shape":"NotificationConfigurationName", - "documentation":"<p>The name of the NotificationConfiguration. Supports RFC 3986's unreserved characters.</p>" + "documentation":"<p>The name of the <code>NotificationConfiguration</code>. Supports RFC 3986's unreserved characters.</p>" }, "description":{ "shape":"NotificationConfigurationDescription", - "documentation":"<p>The description of the NotificationConfiguration.</p>" + "documentation":"<p>The description of the <code>NotificationConfiguration</code>.</p>" }, "status":{ "shape":"NotificationConfigurationStatus", - "documentation":"<p>The status of this NotificationConfiguration.</p> <p>The status should always be INACTIVE when part of the CreateNotificationConfiguration response.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>PARTIALLY_ACTIVE</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p> </li> <li> <p>Any call can be run.</p> </li> </ul> </li> <li> <p> <code>INACTIVE</code> </p> <ul> <li> <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>DELETING</code> </p> <ul> <li> <p>This NotificationConfiguration is being deleted. Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> <li> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The current status of the <code>NotificationConfiguration</code>.</p>" }, "creationTime":{ "shape":"CreationTime", - "documentation":"<p>The creation time of the resource.</p>" + "documentation":"<p>The creation time of the <code>NotificationConfiguration</code>.</p>" }, "aggregationDuration":{ "shape":"AggregationDuration", - "documentation":"<p>The aggregation preference of the NotificationConfiguration.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>LONG</code> </p> <ul> <li> <p>Aggregate notifications for long periods of time (12 hours).</p> </li> </ul> </li> <li> <p> <code>SHORT</code> </p> <ul> <li> <p>Aggregate notifications for short periods of time (5 minutes).</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>Don't aggregate notifications.</p> <p>No delay in delivery.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The aggregation preference of the <code>NotificationConfiguration</code>.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>LONG</code> </p> <ul> <li> <p>Aggregate notifications for long periods of time (12 hours).</p> </li> </ul> </li> <li> <p> <code>SHORT</code> </p> <ul> <li> <p>Aggregate notifications for short periods of time (5 minutes).</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>Don't aggregate notifications.</p> </li> </ul> </li> </ul> </li> </ul>" } }, "documentation":"<p>Contains the complete list of fields for a NotificationConfiguration.</p>" @@ -1473,7 +2735,7 @@ }, "id":{ "shape":"NotificationEventId", - "documentation":"<p>The unique identifier for a NotificationEvent.</p>" + "documentation":"<p>The unique identifier for a <code>NotificationEvent</code>.</p>" }, "sourceEventMetadata":{ "shape":"SourceEventMetadata", @@ -1494,15 +2756,19 @@ }, "eventStatus":{ "shape":"EventStatus", - "documentation":"<p>The assesed nature of the event.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>HEALTHY</code> </p> <ul> <li> <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>UNHEALTHY</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The assessed nature of the event.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>HEALTHY</code> </p> <ul> <li> <p>All <code>EventRules</code> are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>UNHEALTHY</code> </p> <ul> <li> <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> </ul> </li> </ul>" }, "aggregationEventType":{ "shape":"AggregationEventType", - "documentation":"<p>The NotificationConfiguration's aggregation type.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>AGGREGATE</code> </p> <ul> <li> <p>The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.</p> </li> </ul> </li> <li> <p> <code>CHILD</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>The notification isn't aggregated.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The aggregation type of the <code>NotificationConfiguration</code>.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>AGGREGATE</code> </p> <ul> <li> <p>The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.</p> </li> </ul> </li> <li> <p> <code>CHILD</code> </p> <ul> <li> <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>The notification isn't aggregated.</p> </li> </ul> </li> </ul> </li> </ul>" }, "aggregateNotificationEventArn":{ "shape":"NotificationEventArn", - "documentation":"<p>If the value of aggregationEventType is not <code>NONE</code>, this is the Amazon Resource Event (ARN) of the parent aggregate notification.</p> <p>This is omitted if notification isn't aggregated.</p>" + "documentation":"<p>If the value of <code>aggregationEventType</code> is not <code>NONE</code>, this is the Amazon Resource Event (ARN) of the parent aggregate notification.</p> <p>This is omitted if notification isn't aggregated.</p>" + }, + "aggregationSummary":{ + "shape":"AggregationSummary", + "documentation":"<p>Provides additional information about how multiple notifications are grouped.</p>" }, "startTime":{ "shape":"SyntheticTimestamp_date_time", @@ -1521,7 +2787,7 @@ "documentation":"<p>A list of media elements.</p>" } }, - "documentation":"<p>A NotificationEvent is a notification-focused representation of an event. They contain semantic information used by Channels to create end-user notifications.</p>" + "documentation":"<p>A <code>NotificationEvent</code> is a notification-focused representation of an event. They contain semantic information used by Channels to create end-user notifications.</p>" }, "NotificationEventArn":{ "type":"string", @@ -1547,30 +2813,34 @@ }, "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The ARN of the NotificationConfiguration.</p>" + "documentation":"<p>The ARN of the <code>NotificationConfiguration</code>.</p>" }, "relatedAccount":{ "shape":"AccountId", - "documentation":"<p>The account name containing the NotificationHub.</p>" + "documentation":"<p>The account name containing the <code>NotificationHub</code>.</p>" }, "creationTime":{ "shape":"CreationTime", - "documentation":"<p>The creation time of the NotificationEvent.</p>" + "documentation":"<p>The creation time of the <code>NotificationEvent</code>.</p>" }, "notificationEvent":{ "shape":"NotificationEventSummary", - "documentation":"<p>Refers to a NotificationEventSummary object.</p> <p>Similar in structure to <code>content</code> in the GetNotificationEvent response.</p>" + "documentation":"<p>Refers to a <code>NotificationEventSummary</code> object.</p> <p>Similar in structure to <code>content</code> in the <code>GetNotificationEvent</code> response.</p>" }, "aggregationEventType":{ "shape":"AggregationEventType", - "documentation":"<p>The NotificationConfiguration's aggregation type.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>AGGREGATE</code> </p> <ul> <li> <p>The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.</p> </li> </ul> </li> <li> <p> <code>CHILD</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>The notification isn't aggregated.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The <code>NotificationConfiguration</code>'s aggregation type.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>AGGREGATE</code> </p> <ul> <li> <p>The notification event is an aggregate notification. Aggregate notifications summarize grouped events over a specified time period.</p> </li> </ul> </li> <li> <p> <code>CHILD</code> </p> <ul> <li> <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>The notification isn't aggregated.</p> </li> </ul> </li> </ul> </li> </ul>" }, "aggregateNotificationEventArn":{ "shape":"NotificationEventArn", - "documentation":"<p>The ARN of the aggregatedNotificationEventArn to match.</p>" + "documentation":"<p>The ARN of the <code>aggregatedNotificationEventArn</code> to match.</p>" + }, + "aggregationSummary":{ + "shape":"AggregationSummary", + "documentation":"<p>Provides an aggregated summary data for notification events.</p>" } }, - "documentation":"<p>Describes a short summary of a NotificationEvent. This is only used when listing notification events.</p>" + "documentation":"<p>Describes a short summary of a <code>NotificationEvent</code>. This is only used when listing notification events.</p>" }, "NotificationEventSummary":{ "type":"structure", @@ -1596,14 +2866,14 @@ }, "eventStatus":{ "shape":"EventStatus", - "documentation":"<p>The notification event status.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>HEALTHY</code> </p> <ul> <li> <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>UNHEALTHY</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>Provides additional information about the current status of the <code>NotificationEvent</code>.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>HEALTHY</code> </p> <ul> <li> <p>All <code>EventRules</code> are <code>ACTIVE</code>.</p> </li> </ul> </li> <li> <p> <code>UNHEALTHY</code> </p> <ul> <li> <p>Some <code>EventRules</code> are <code>ACTIVE</code> and some are <code>INACTIVE</code>.</p> </li> </ul> </li> </ul> </li> </ul>" }, "notificationType":{ "shape":"NotificationType", "documentation":"<p>The type of event causing the notification.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ALERT</code> </p> <ul> <li> <p>A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.</p> </li> </ul> </li> <li> <p> <code>WARNING</code> </p> <ul> <li> <p>A notification about an event where an issue is about to arise. For example, something is approaching a threshold.</p> </li> </ul> </li> <li> <p> <code>ANNOUNCEMENT</code> </p> <ul> <li> <p>A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.</p> </li> </ul> </li> <li> <p> <code>INFORMATIONAL</code> </p> <ul> <li> <p>A notification about informational messages. For example, recommendations, service announcements, or reminders.</p> </li> </ul> </li> </ul> </li> </ul>" } }, - "documentation":"<p>Describes a short summary and metadata for a notification event.</p>" + "documentation":"<p>Describes a short summary and metadata for a <code>NotificationEvent</code>.</p>" }, "NotificationEvents":{ "type":"list", @@ -1627,14 +2897,14 @@ }, "creationTime":{ "shape":"CreationTime", - "documentation":"<p>The date and time the resource was created.</p>" + "documentation":"<p>The date and time the <code>NotificationHubOverview</code> was created.</p>" }, "lastActivationTime":{ "shape":"LastActivationTime", - "documentation":"<p>The most recent time this NotificationHub had an ACTIVE status.</p>" + "documentation":"<p>The most recent time this <code>NotificationHub</code> had an <code>ACTIVE</code> status.</p>" } }, - "documentation":"<p>Describes an overview of a NotificationHub.</p> <p>A NotificationHub is an account-level setting used to select the Regions where you want to store, process and replicate your notifications.</p>" + "documentation":"<p>Describes an overview of a <code>NotificationHub</code>.</p> <p>A <code>NotificationConfiguration</code> is an account-level setting used to select the Regions where you want to store, process and replicate your notifications.</p>" }, "NotificationHubStatus":{ "type":"string", @@ -1655,14 +2925,14 @@ "members":{ "status":{ "shape":"NotificationHubStatus", - "documentation":"<p>Status information about the NotificationHub.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>Incoming NotificationEvents are replicated to this NotificationHub.</p> </li> </ul> </li> <li> <p> <code>REGISTERING</code> </p> <ul> <li> <p>The NotificationHub is initializing. A NotificationHub with this status can't be deregistered.</p> </li> </ul> </li> <li> <p> <code>DEREGISTERING</code> </p> <ul> <li> <p>The NotificationHub is being deleted. You can't register additional NotificationHubs in the same Region as a NotificationHub with this status.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>Status information about the <code>NotificationHub</code>.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>Incoming <code>NotificationEvents</code> are replicated to this <code>NotificationHub</code>.</p> </li> </ul> </li> <li> <p> <code>REGISTERING</code> </p> <ul> <li> <p>The <code>NotificationConfiguration</code> is initializing. A <code>NotificationConfiguration</code> with this status can't be deregistered.</p> </li> </ul> </li> <li> <p> <code>DEREGISTERING</code> </p> <ul> <li> <p>The <code>NotificationConfiguration</code> is being deleted. You can't register additional <code>NotificationHubs</code> in the same Region as a <code>NotificationConfiguration</code> with this status.</p> </li> </ul> </li> </ul> </li> </ul>" }, "reason":{ "shape":"NotificationHubStatusReason", - "documentation":"<p>An Explanation for the current status.</p>" + "documentation":"<p>An explanation for the current status.</p>" } }, - "documentation":"<p>NotificationHub status information.</p>" + "documentation":"<p>Provides additional information about the current <code>NotificationHub</code> status.</p>" }, "NotificationHubs":{ "type":"list", @@ -1677,6 +2947,21 @@ "INFORMATIONAL" ] }, + "NotificationsAccessForOrganization":{ + "type":"structure", + "required":["accessStatus"], + "members":{ + "accessStatus":{ + "shape":"AccessStatus", + "documentation":"<p>Access Status for the Orgs Service.</p>" + } + }, + "documentation":"<p>Orgs Service trust for User Notifications.</p>" + }, + "OrganizationalUnitId":{ + "type":"string", + "pattern":"Root|ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}" + }, "QuotaCode":{"type":"string"}, "Region":{ "type":"string", @@ -1695,7 +2980,7 @@ "members":{ "notificationHubRegion":{ "shape":"Region", - "documentation":"<p>The Region of the NotificationHub.</p>" + "documentation":"<p>The Region of the <code>NotificationHub</code>.</p>" } } }, @@ -1709,11 +2994,11 @@ "members":{ "notificationHubRegion":{ "shape":"Region", - "documentation":"<p>The Region of the NotificationHub.</p>" + "documentation":"<p>The Region of the <code>NotificationHub</code>.</p>" }, "statusSummary":{ "shape":"NotificationHubStatusSummary", - "documentation":"<p>NotificationHub status information.</p>" + "documentation":"<p>Provides additional information about the current <code>NotificationConfiguration</code> status information.</p>" }, "creationTime":{ "shape":"CreationTime", @@ -1773,6 +3058,17 @@ "type":"list", "member":{"shape":"Resource"} }, + "SampleAggregationDimensionValues":{ + "type":"list", + "member":{"shape":"SampleAggregationDimensionValuesMemberString"}, + "max":50, + "min":0 + }, + "SampleAggregationDimensionValuesMemberString":{ + "type":"string", + "max":256, + "min":1 + }, "SchemaVersion":{ "type":"string", "enum":["v1.0"] @@ -1842,11 +3138,11 @@ }, "relatedAccount":{ "shape":"SourceEventMetadataRelatedAccountString", - "documentation":"<p>The Primary AWS account of Source Event</p>" + "documentation":"<p>The primary Amazon Web Services account of <code>SourceEvent</code>.</p>" }, "source":{ "shape":"Source", - "documentation":"<p>The AWS servvice the event originates from. For example <code>aws.cloudwatch</code>.</p>" + "documentation":"<p>The Amazon Web Services service the event originates from. For example <code>aws.cloudwatch</code>.</p>" }, "eventOccurrenceTime":{ "shape":"SyntheticTimestamp_date_time", @@ -1854,11 +3150,11 @@ }, "eventType":{ "shape":"SourceEventMetadataEventTypeString", - "documentation":"<p>The type of event. For example, an AWS CloudWatch state change.</p>" + "documentation":"<p>The type of event. For example, an Amazon CloudWatch state change.</p>" }, "relatedResources":{ "shape":"Resources", - "documentation":"<p>A list of resources related to this NotificationEvent.</p>" + "documentation":"<p>A list of resources related to this <code>NotificationEvent</code>.</p>" } }, "documentation":"<p>Describes the metadata for a source event.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events-structure.html\">Event structure reference</a> in the <i>Amazon EventBridge User Guide</i>.</p>" @@ -1897,14 +3193,14 @@ }, "source":{ "shape":"String", - "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" + "documentation":"<p>The matched event source.</p> <p>Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" }, "eventType":{ "shape":"SourceEventMetadataSummaryEventTypeString", - "documentation":"<p>The event type to match.</p> <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from AWS services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" + "documentation":"<p>The event type to match.</p> <p>Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level\">Event delivery from Amazon Web Services services</a> in the <i>Amazon EventBridge User Guide</i>.</p>" } }, - "documentation":"<p>Contains metadata about the event that caused the NotificationEvent. For other specific values, see sourceEventMetadata.</p>" + "documentation":"<p>Contains metadata about the event that caused the <code>NotificationEvent</code>. For other specific values, see <code>sourceEventMetadata</code>.</p>" }, "SourceEventMetadataSummaryEventOriginRegionString":{ "type":"string", @@ -1922,6 +3218,54 @@ "value":{"shape":"EventRuleStatusSummary"} }, "String":{"type":"string"}, + "SummarizationDimensionDetail":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"<p>The name of the SummarizationDimensionDetail.</p>" + }, + "value":{ + "shape":"String", + "documentation":"<p>Value of the property used to summarize aggregated events.</p>" + } + }, + "documentation":"<p>Provides detailed information about the dimensions used for event summarization and aggregation.</p>" + }, + "SummarizationDimensionDetails":{ + "type":"list", + "member":{"shape":"SummarizationDimensionDetail"} + }, + "SummarizationDimensionOverview":{ + "type":"structure", + "required":[ + "name", + "count" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"<p>Name of the summarization dimension.</p>" + }, + "count":{ + "shape":"Integer", + "documentation":"<p>Total number of occurrences for this dimension.</p>" + }, + "sampleValues":{ + "shape":"SampleAggregationDimensionValues", + "documentation":"<p>Indicates the sample values found within the dimension.</p>" + } + }, + "documentation":"<p>Provides an overview of how data is summarized across different dimensions.</p>" + }, + "SummarizationDimensionOverviews":{ + "type":"list", + "member":{"shape":"SummarizationDimensionOverview"} + }, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" @@ -2013,7 +3357,7 @@ }, "displayText":{ "shape":"TextPartValueDisplayTextString", - "documentation":"<p>A short single line description of the link. Must be hyperlinked with the URL itself. </p> <p>Used for text parts with the type <code>URL</code>.</p>" + "documentation":"<p>A short single line description of the link. Must be hyper-linked with the URL itself. </p> <p>Used for text parts with the type <code>URL</code>.</p>" }, "textByLocale":{ "shape":"TextByLocale", @@ -2096,17 +3440,17 @@ "members":{ "arn":{ "shape":"EventRuleArn", - "documentation":"<p>The Amazon Resource Name (ARN) to use to update the EventRule.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) to use to update the <code>EventRule</code>.</p>", "location":"uri", "locationName":"arn" }, "eventPattern":{ "shape":"EventRuleEventPattern", - "documentation":"<p>An additional event pattern used to further filter the events this EventRule receives.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html\">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i> </p>" + "documentation":"<p>An additional event pattern used to further filter the events this <code>EventRule</code> receives.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html\">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i> </p>" }, "regions":{ "shape":"Regions", - "documentation":"<p>A list of AWS Regions that sends events to this EventRule.</p>" + "documentation":"<p>A list of Amazon Web Services Regions that sends events to this <code>EventRule</code>.</p>" } } }, @@ -2120,11 +3464,11 @@ "members":{ "arn":{ "shape":"EventRuleArn", - "documentation":"<p>The Amazon Resource Name (ARN) to use to update the EventRule.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) to use to update the <code>EventRule</code>.</p>" }, "notificationConfigurationArn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The ARN of the NotificationConfiguration.</p>" + "documentation":"<p>The ARN of the <code>NotificationConfiguration</code>.</p>" }, "statusSummaryByRegion":{ "shape":"StatusSummaryByRegion", @@ -2138,21 +3482,21 @@ "members":{ "arn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The Amazon Resource Name (ARN) used to update the NotificationConfiguration.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) used to update the <code>NotificationConfiguration</code>.</p>", "location":"uri", "locationName":"arn" }, "name":{ "shape":"NotificationConfigurationName", - "documentation":"<p>The name of the NotificationConfiguration.</p>" + "documentation":"<p>The name of the <code>NotificationConfiguration</code>.</p>" }, "description":{ "shape":"NotificationConfigurationDescription", - "documentation":"<p>The description of the NotificationConfiguration.</p>" + "documentation":"<p>The description of the <code>NotificationConfiguration</code>.</p>" }, "aggregationDuration":{ "shape":"AggregationDuration", - "documentation":"<p>The status of this NotificationConfiguration.</p> <p>The status should always be <code>INACTIVE</code> when part of the CreateNotificationConfiguration response.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>ACTIVE</code> </p> <ul> <li> <p>All EventRules are <code>ACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>PARTIALLY_ACTIVE</code> </p> <ul> <li> <p>Some EventRules are <code>ACTIVE</code> and some are <code>INACTIVE</code>. Any call can be run.</p> </li> <li> <p>Any call can be run.</p> </li> </ul> </li> <li> <p> <code>INACTIVE</code> </p> <ul> <li> <p>All EventRules are <code>INACTIVE</code> and any call can be run.</p> </li> </ul> </li> <li> <p> <code>DELETING</code> </p> <ul> <li> <p>This NotificationConfiguration is being deleted.</p> </li> <li> <p>Only <code>GET</code> and <code>LIST</code> calls can be run.</p> </li> </ul> </li> </ul> </li> </ul>" + "documentation":"<p>The aggregation preference of the <code>NotificationConfiguration</code>.</p> <ul> <li> <p>Values:</p> <ul> <li> <p> <code>LONG</code> </p> <ul> <li> <p>Aggregate notifications for long periods of time (12 hours).</p> </li> </ul> </li> <li> <p> <code>SHORT</code> </p> <ul> <li> <p>Aggregate notifications for short periods of time (5 minutes).</p> </li> </ul> </li> <li> <p> <code>NONE</code> </p> <ul> <li> <p>Don't aggregate notifications.</p> </li> </ul> </li> </ul> </li> </ul>" } } }, @@ -2162,7 +3506,7 @@ "members":{ "arn":{ "shape":"NotificationConfigurationArn", - "documentation":"<p>The ARN used to update the NotificationConfiguration.</p>" + "documentation":"<p>The ARN used to update the <code>NotificationConfiguration</code>.</p>" } } }, @@ -2223,5 +3567,5 @@ ] } }, - "documentation":"<p>The <i>AWS User Notifications API Reference</i> provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.</p> <p>User Notification control APIs are currently available in US East (Virginia) - <code>us-east-1</code>.</p> <p> <a href=\"https://docs.aws.amazon.com/notifications/latest/APIReference/API_GetNotificationEvent.html\">GetNotificationEvent</a> and <a href=\"https://docs.aws.amazon.com/notifications/latest/APIReference/API_ListNotificationEvents.html\">ListNotificationEvents</a> APIs are currently available in <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/supported-regions.html\">commercial partition Regions</a> and only return notifications stored in the same Region in which they're called.</p> <p>The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html>\">notification hub</a> in addition to US East (Virginia).</p>" + "documentation":"<p>The <i>Amazon Web Services User Notifications API Reference</i> provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.</p> <p>User Notification control plane APIs are currently available in US East (Virginia) - <code>us-east-1</code>.</p> <p> <a href=\"https://docs.aws.amazon.com/notifications/latest/APIReference/API_GetNotificationEvent.html\">GetNotificationEvent</a> and <a href=\"https://docs.aws.amazon.com/notifications/latest/APIReference/API_ListNotificationEvents.html\">ListNotificationEvents</a> APIs are currently available in <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/supported-regions.html\">commercial partition Regions</a> and only return notifications stored in the same Region in which they're called.</p> <p>The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a <a href=\"https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html\">notification hub</a> in addition to US East (Virginia).</p>" } diff --git a/contrib/python/botocore/py3/botocore/data/opensearchserverless/2021-11-01/service-2.json b/contrib/python/botocore/py3/botocore/data/opensearchserverless/2021-11-01/service-2.json index 1cfc970ee35..5d66d180a60 100644 --- a/contrib/python/botocore/py3/botocore/data/opensearchserverless/2021-11-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/opensearchserverless/2021-11-01/service-2.json @@ -2,6 +2,7 @@ "version":"2.0", "metadata":{ "apiVersion":"2021-11-01", + "auth":["aws.auth#sigv4"], "endpointPrefix":"aoss", "jsonVersion":"1.0", "protocol":"json", @@ -11,8 +12,7 @@ "signatureVersion":"v4", "signingName":"aoss", "targetPrefix":"OpenSearchServerless", - "uid":"opensearchserverless-2021-11-01", - "auth":["aws.auth#sigv4"] + "uid":"opensearchserverless-2021-11-01" }, "operations":{ "BatchGetCollection":{ @@ -601,33 +601,33 @@ "AccessPolicyDetail":{ "type":"structure", "members":{ - "createdDate":{ - "shape":"Long", - "documentation":"<p>The date the policy was created.</p>" - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>The description of the policy.</p>" - }, - "lastModifiedDate":{ - "shape":"Long", - "documentation":"<p>The timestamp of when the policy was last modified.</p>" + "type":{ + "shape":"AccessPolicyType", + "documentation":"<p>The type of access policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the policy.</p>" }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"<p>The version of the policy.</p>" + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>The description of the policy.</p>" + }, "policy":{ "shape":"Document", "documentation":"<p>The JSON policy document without any whitespaces.</p>" }, - "policyVersion":{ - "shape":"PolicyVersion", - "documentation":"<p>The version of the policy.</p>" + "createdDate":{ + "shape":"Long", + "documentation":"<p>The date the policy was created.</p>" }, - "type":{ - "shape":"AccessPolicyType", - "documentation":"<p>The type of access policy.</p>" + "lastModifiedDate":{ + "shape":"Long", + "documentation":"<p>The timestamp of when the policy was last modified.</p>" } }, "documentation":"<p>Details about an OpenSearch Serverless access policy.</p>" @@ -649,17 +649,9 @@ "AccessPolicySummary":{ "type":"structure", "members":{ - "createdDate":{ - "shape":"Long", - "documentation":"<p>The Epoch time when the access policy was created.</p>" - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>The description of the access policy.</p>" - }, - "lastModifiedDate":{ - "shape":"Long", - "documentation":"<p>The date and time when the collection was last modified.</p>" + "type":{ + "shape":"AccessPolicyType", + "documentation":"<p>The type of access policy. Currently, the only available type is <code>data</code>.</p>" }, "name":{ "shape":"PolicyName", @@ -669,9 +661,17 @@ "shape":"PolicyVersion", "documentation":"<p>The version of the policy.</p>" }, - "type":{ - "shape":"AccessPolicyType", - "documentation":"<p>The type of access policy. Currently, the only available type is <code>data</code>.</p>" + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>The description of the access policy.</p>" + }, + "createdDate":{ + "shape":"Long", + "documentation":"<p>The Epoch time when the access policy was created.</p>" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"<p>The date and time when the collection was last modified.</p>" } }, "documentation":"<p>A summary of the data access policy.</p>" @@ -813,61 +813,61 @@ "CollectionDetail":{ "type":"structure", "members":{ - "arn":{ - "shape":"String", - "documentation":"<p>The Amazon Resource Name (ARN) of the collection.</p>" + "id":{ + "shape":"CollectionId", + "documentation":"<p>A unique identifier for the collection.</p>" }, - "collectionEndpoint":{ - "shape":"String", - "documentation":"<p>Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.</p>" + "name":{ + "shape":"CollectionName", + "documentation":"<p>The name of the collection.</p>" }, - "createdDate":{ - "shape":"Long", - "documentation":"<p>The Epoch time when the collection was created.</p>" + "status":{ + "shape":"CollectionStatus", + "documentation":"<p>The current status of the collection.</p>" }, - "dashboardEndpoint":{ - "shape":"String", - "documentation":"<p>Collection-specific endpoint used to access OpenSearch Dashboards.</p>" + "type":{ + "shape":"CollectionType", + "documentation":"<p>The type of collection.</p>" }, "description":{ "shape":"String", "documentation":"<p>A description of the collection.</p>" }, - "failureCode":{ - "shape":"String", - "documentation":"<p>A failure code associated with the request.</p>" - }, - "failureMessage":{ + "arn":{ "shape":"String", - "documentation":"<p>A message associated with the failure code.</p>" - }, - "id":{ - "shape":"CollectionId", - "documentation":"<p>A unique identifier for the collection.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the collection.</p>" }, "kmsKeyArn":{ "shape":"String", "documentation":"<p>The ARN of the Amazon Web Services KMS key used to encrypt the collection.</p>" }, + "standbyReplicas":{ + "shape":"StandbyReplicas", + "documentation":"<p>Details about an OpenSearch Serverless collection.</p>" + }, + "createdDate":{ + "shape":"Long", + "documentation":"<p>The Epoch time when the collection was created.</p>" + }, "lastModifiedDate":{ "shape":"Long", "documentation":"<p>The date and time when the collection was last modified.</p>" }, - "name":{ - "shape":"CollectionName", - "documentation":"<p>The name of the collection.</p>" + "collectionEndpoint":{ + "shape":"String", + "documentation":"<p>Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.</p>" }, - "standbyReplicas":{ - "shape":"StandbyReplicas", - "documentation":"<p>Details about an OpenSearch Serverless collection.</p>" + "dashboardEndpoint":{ + "shape":"String", + "documentation":"<p>Collection-specific endpoint used to access OpenSearch Dashboards.</p>" }, - "status":{ - "shape":"CollectionStatus", - "documentation":"<p>The current status of the collection.</p>" + "failureCode":{ + "shape":"String", + "documentation":"<p>A failure code associated with the request.</p>" }, - "type":{ - "shape":"CollectionType", - "documentation":"<p>The type of collection.</p>" + "failureMessage":{ + "shape":"String", + "documentation":"<p>A message associated with the failure code.</p>" } }, "documentation":"<p>Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.</p>" @@ -879,14 +879,6 @@ "CollectionErrorDetail":{ "type":"structure", "members":{ - "errorCode":{ - "shape":"String", - "documentation":"<p>The error code for the request. For example, <code>NOT_FOUND</code>.</p>" - }, - "errorMessage":{ - "shape":"String", - "documentation":"<p>A description of the error. For example, <code>The specified Collection is not found.</code> </p>" - }, "id":{ "shape":"CollectionId", "documentation":"<p>If the request contains collection IDs, the response includes the IDs provided in the request.</p>" @@ -894,6 +886,14 @@ "name":{ "shape":"CollectionName", "documentation":"<p>If the request contains collection names, the response includes the names provided in the request.</p>" + }, + "errorMessage":{ + "shape":"String", + "documentation":"<p>A description of the error. For example, <code>The specified Collection is not found.</code> </p>" + }, + "errorCode":{ + "shape":"String", + "documentation":"<p>The error code for the request. For example, <code>NOT_FOUND</code>.</p>" } }, "documentation":"<p>Error information for an OpenSearch Serverless request.</p>" @@ -920,7 +920,7 @@ "type":"string", "max":40, "min":3, - "pattern":"^[a-z0-9]{3,40}$" + "pattern":"[a-z0-9]{3,40}" }, "CollectionIds":{ "type":"list", @@ -932,7 +932,7 @@ "type":"string", "max":32, "min":3, - "pattern":"^[a-z][a-z0-9-]+$" + "pattern":"[a-z][a-z0-9-]+" }, "CollectionNames":{ "type":"list", @@ -956,10 +956,6 @@ "CollectionSummary":{ "type":"structure", "members":{ - "arn":{ - "shape":"String", - "documentation":"<p>The Amazon Resource Name (ARN) of the collection.</p>" - }, "id":{ "shape":"CollectionId", "documentation":"<p>The unique identifier of the collection.</p>" @@ -971,6 +967,10 @@ "status":{ "shape":"CollectionStatus", "documentation":"<p>The current status of the collection.</p>" + }, + "arn":{ + "shape":"String", + "documentation":"<p>The Amazon Resource Name (ARN) of the collection.</p>" } }, "documentation":"<p>Details about each OpenSearch Serverless collection.</p>" @@ -992,7 +992,7 @@ "type":"string", "max":32, "min":3, - "pattern":"^[a-z][a-z0-9-]+$" + "pattern":"[a-z][a-z0-9-]+" }, "ConflictException":{ "type":"structure", @@ -1005,31 +1005,31 @@ "CreateAccessPolicyRequest":{ "type":"structure", "required":[ + "type", "name", - "policy", - "type" + "policy" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>" + "type":{ + "shape":"AccessPolicyType", + "documentation":"<p>The type of policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the policy.</p>" }, + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>" + }, "policy":{ "shape":"PolicyDocument", "documentation":"<p>The JSON policy document to use as the content for the policy.</p>" }, - "type":{ - "shape":"AccessPolicyType", - "documentation":"<p>The type of policy.</p>" + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -1045,45 +1045,45 @@ "CreateCollectionDetail":{ "type":"structure", "members":{ - "arn":{ - "shape":"String", - "documentation":"<p>The Amazon Resource Name (ARN) of the collection.</p>" + "id":{ + "shape":"CollectionId", + "documentation":"<p>The unique identifier of the collection.</p>" }, - "createdDate":{ - "shape":"Long", - "documentation":"<p>The Epoch time when the collection was created.</p>" + "name":{ + "shape":"CollectionName", + "documentation":"<p>The name of the collection.</p>" + }, + "status":{ + "shape":"CollectionStatus", + "documentation":"<p>The current status of the collection.</p>" + }, + "type":{ + "shape":"CollectionType", + "documentation":"<p>The type of collection.</p>" }, "description":{ "shape":"String", "documentation":"<p>A description of the collection.</p>" }, - "id":{ - "shape":"CollectionId", - "documentation":"<p>The unique identifier of the collection.</p>" + "arn":{ + "shape":"String", + "documentation":"<p>The Amazon Resource Name (ARN) of the collection.</p>" }, "kmsKeyArn":{ "shape":"String", "documentation":"<p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.</p>" }, - "lastModifiedDate":{ - "shape":"Long", - "documentation":"<p>The date and time when the collection was last modified.</p>" - }, - "name":{ - "shape":"CollectionName", - "documentation":"<p>The name of the collection.</p>" - }, "standbyReplicas":{ "shape":"StandbyReplicas", "documentation":"<p>Creates details about an OpenSearch Serverless collection.</p>" }, - "status":{ - "shape":"CollectionStatus", - "documentation":"<p>The current status of the collection.</p>" + "createdDate":{ + "shape":"Long", + "documentation":"<p>The Epoch time when the collection was created.</p>" }, - "type":{ - "shape":"CollectionType", - "documentation":"<p>The type of collection.</p>" + "lastModifiedDate":{ + "shape":"Long", + "documentation":"<p>The date and time when the collection was last modified.</p>" } }, "documentation":"<p>Details about the created OpenSearch Serverless collection.</p>" @@ -1092,30 +1092,30 @@ "type":"structure", "required":["name"], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true + "name":{ + "shape":"CollectionName", + "documentation":"<p>Name of the collection.</p>" + }, + "type":{ + "shape":"CollectionType", + "documentation":"<p>The type of collection.</p>" }, "description":{ "shape":"CreateCollectionRequestDescriptionString", "documentation":"<p>Description of the collection.</p>" }, - "name":{ - "shape":"CollectionName", - "documentation":"<p>Name of the collection.</p>" + "tags":{ + "shape":"Tags", + "documentation":"<p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p>" }, "standbyReplicas":{ "shape":"StandbyReplicas", "documentation":"<p>Indicates whether standby replicas should be used for a collection.</p>" }, - "tags":{ - "shape":"Tags", - "documentation":"<p>An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.</p>" - }, - "type":{ - "shape":"CollectionType", - "documentation":"<p>The type of collection.</p>" + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -1137,10 +1137,6 @@ "type":"structure", "required":["instanceArn"], "members":{ - "groupAttribute":{ - "shape":"IamIdentityCenterGroupAttribute", - "documentation":"<p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>" - }, "instanceArn":{ "shape":"IamIdentityCenterInstanceArn", "documentation":"<p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.</p>" @@ -1148,6 +1144,10 @@ "userAttribute":{ "shape":"IamIdentityCenterUserAttribute", "documentation":"<p>The user attribute for this IAM Identity Center integration. Defaults to <code>UserId</code>.</p>" + }, + "groupAttribute":{ + "shape":"IamIdentityCenterGroupAttribute", + "documentation":"<p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>" } }, "documentation":"<p>Describes IAM Identity Center options for creating an OpenSearch Serverless security configuration in the form of a key-value map.</p>" @@ -1155,31 +1155,31 @@ "CreateLifecyclePolicyRequest":{ "type":"structure", "required":[ + "type", "name", - "policy", - "type" + "policy" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>A description of the lifecycle policy.</p>" + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"<p>The type of lifecycle policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the lifecycle policy.</p>" }, + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>A description of the lifecycle policy.</p>" + }, "policy":{ "shape":"PolicyDocument", "documentation":"<p>The JSON policy document to use as the content for the lifecycle policy.</p>" }, - "type":{ - "shape":"LifecyclePolicyType", - "documentation":"<p>The type of lifecycle policy.</p>" + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -1195,34 +1195,34 @@ "CreateSecurityConfigRequest":{ "type":"structure", "required":[ - "name", - "type" + "type", + "name" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true - }, - "description":{ - "shape":"ConfigDescription", - "documentation":"<p>A description of the security configuration.</p>" - }, - "iamIdentityCenterOptions":{ - "shape":"CreateIamIdentityCenterConfigOptions", - "documentation":"<p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.</p>" + "type":{ + "shape":"SecurityConfigType", + "documentation":"<p>The type of security configuration.</p>" }, "name":{ "shape":"ConfigName", "documentation":"<p>The name of the security configuration.</p>" }, + "description":{ + "shape":"ConfigDescription", + "documentation":"<p>A description of the security configuration.</p>" + }, "samlOptions":{ "shape":"SamlConfigOptions", "documentation":"<p>Describes SAML options in in the form of a key-value map. This field is required if you specify <code>saml</code> for the <code>type</code> parameter.</p>" }, - "type":{ - "shape":"SecurityConfigType", - "documentation":"<p>The type of security configuration.</p>" + "iamIdentityCenterOptions":{ + "shape":"CreateIamIdentityCenterConfigOptions", + "documentation":"<p>Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.</p>" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -1238,31 +1238,31 @@ "CreateSecurityPolicyRequest":{ "type":"structure", "required":[ + "type", "name", - "policy", - "type" + "policy" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>" + "type":{ + "shape":"SecurityPolicyType", + "documentation":"<p>The type of security policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the policy.</p>" }, + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>" + }, "policy":{ "shape":"PolicyDocument", "documentation":"<p>The JSON policy document to use as the content for the new policy.</p>" }, - "type":{ - "shape":"SecurityPolicyType", - "documentation":"<p>The type of security policy.</p>" + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -1297,30 +1297,30 @@ "type":"structure", "required":[ "name", - "subnetIds", - "vpcId" + "vpcId", + "subnetIds" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true - }, "name":{ "shape":"VpcEndpointName", "documentation":"<p>The name of the interface endpoint.</p>" }, - "securityGroupIds":{ - "shape":"SecurityGroupIds", - "documentation":"<p>The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>" + "vpcId":{ + "shape":"VpcId", + "documentation":"<p>The ID of the VPC from which you'll access OpenSearch Serverless.</p>" }, "subnetIds":{ "shape":"SubnetIds", "documentation":"<p>The ID of one or more subnets from which you'll access OpenSearch Serverless.</p>" }, - "vpcId":{ - "shape":"VpcId", - "documentation":"<p>The ID of the VPC from which you'll access OpenSearch Serverless.</p>" + "securityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"<p>The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -1336,22 +1336,22 @@ "DeleteAccessPolicyRequest":{ "type":"structure", "required":[ - "name", - "type" + "type", + "name" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true + "type":{ + "shape":"AccessPolicyType", + "documentation":"<p>The type of policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the policy to delete.</p>" }, - "type":{ - "shape":"AccessPolicyType", - "documentation":"<p>The type of policy.</p>" + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -1382,14 +1382,14 @@ "type":"structure", "required":["id"], "members":{ + "id":{ + "shape":"CollectionId", + "documentation":"<p>The unique identifier of the collection. For example, <code>1iu5usc406kd</code>. The ID is part of the collection endpoint. You can also retrieve it using the <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html\">ListCollections</a> API.</p>" + }, "clientToken":{ "shape":"ClientToken", "documentation":"<p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>", "idempotencyToken":true - }, - "id":{ - "shape":"CollectionId", - "documentation":"<p>The unique identifier of the collection. For example, <code>1iu5usc406kd</code>. The ID is part of the collection endpoint. You can also retrieve it using the <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/ServerlessAPIReference/API_ListCollections.html\">ListCollections</a> API.</p>" } } }, @@ -1405,22 +1405,22 @@ "DeleteLifecyclePolicyRequest":{ "type":"structure", "required":[ - "name", - "type" + "type", + "name" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"<p>The type of lifecycle policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the policy to delete.</p>" }, - "type":{ - "shape":"LifecyclePolicyType", - "documentation":"<p>The type of lifecycle policy.</p>" + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -1433,14 +1433,14 @@ "type":"structure", "required":["id"], "members":{ + "id":{ + "shape":"SecurityConfigId", + "documentation":"<p>The security configuration identifier. For SAML the ID will be <code>saml/<accountId>/<idpProviderName></code>. For example, <code>saml/123456789123/OKTADev</code>.</p>" + }, "clientToken":{ "shape":"ClientToken", "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", "idempotencyToken":true - }, - "id":{ - "shape":"SecurityConfigId", - "documentation":"<p>The security configuration identifier. For SAML the ID will be <code>saml/<accountId>/<idpProviderName></code>. For example, <code>saml/123456789123/OKTADev</code>.</p>" } } }, @@ -1452,22 +1452,22 @@ "DeleteSecurityPolicyRequest":{ "type":"structure", "required":[ - "name", - "type" + "type", + "name" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true + "type":{ + "shape":"SecurityPolicyType", + "documentation":"<p>The type of policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the policy to delete.</p>" }, - "type":{ - "shape":"SecurityPolicyType", - "documentation":"<p>The type of policy.</p>" + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -1498,14 +1498,14 @@ "type":"structure", "required":["id"], "members":{ + "id":{ + "shape":"VpcEndpointId", + "documentation":"<p>The VPC endpoint identifier.</p>" + }, "clientToken":{ "shape":"ClientToken", "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", "idempotencyToken":true - }, - "id":{ - "shape":"VpcEndpointId", - "documentation":"<p>The VPC endpoint identifier.</p>" } } }, @@ -1527,18 +1527,18 @@ "EffectiveLifecyclePolicyDetail":{ "type":"structure", "members":{ - "noMinRetentionPeriod":{ - "shape":"Boolean", - "documentation":"<p>The minimum number of index retention days set. That is an optional param that will return as <code>true</code> if the minimum number of days or hours is not set to a index resource.</p>" - }, - "policyName":{ - "shape":"PolicyName", - "documentation":"<p>The name of the lifecycle policy.</p>" + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"<p>The type of lifecycle policy.</p>" }, "resource":{ "shape":"Resource", "documentation":"<p>The name of the OpenSearch Serverless index resource.</p>" }, + "policyName":{ + "shape":"PolicyName", + "documentation":"<p>The name of the lifecycle policy.</p>" + }, "resourceType":{ "shape":"ResourceType", "documentation":"<p>The type of OpenSearch Serverless resource. Currently, the only supported resource is <code>index</code>.</p>" @@ -1547,9 +1547,9 @@ "shape":"String", "documentation":"<p>The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.</p>" }, - "type":{ - "shape":"LifecyclePolicyType", - "documentation":"<p>The type of lifecycle policy.</p>" + "noMinRetentionPeriod":{ + "shape":"Boolean", + "documentation":"<p>The minimum number of index retention days set. That is an optional param that will return as <code>true</code> if the minimum number of days or hours is not set to a index resource.</p>" } }, "documentation":"<p>Error information for an OpenSearch Serverless request.</p>" @@ -1561,21 +1561,21 @@ "EffectiveLifecyclePolicyErrorDetail":{ "type":"structure", "members":{ - "errorCode":{ - "shape":"String", - "documentation":"<p>The error code for the request.</p>" - }, - "errorMessage":{ - "shape":"String", - "documentation":"<p>A description of the error. For example, <code>The specified Index resource is not found</code>.</p>" + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"<p>The type of lifecycle policy.</p>" }, "resource":{ "shape":"Resource", "documentation":"<p>The name of OpenSearch Serverless index resource.</p>" }, - "type":{ - "shape":"LifecyclePolicyType", - "documentation":"<p>The type of lifecycle policy.</p>" + "errorMessage":{ + "shape":"String", + "documentation":"<p>A description of the error. For example, <code>The specified Index resource is not found</code>.</p>" + }, + "errorCode":{ + "shape":"String", + "documentation":"<p>The error code for the request.</p>" } }, "documentation":"<p>Error information for an OpenSearch Serverless request.</p>" @@ -1587,17 +1587,17 @@ "GetAccessPolicyRequest":{ "type":"structure", "required":[ - "name", - "type" + "type", + "name" ], "members":{ - "name":{ - "shape":"PolicyName", - "documentation":"<p>The name of the access policy.</p>" - }, "type":{ "shape":"AccessPolicyType", "documentation":"<p>Tye type of policy. Currently, the only supported value is <code>data</code>.</p>" + }, + "name":{ + "shape":"PolicyName", + "documentation":"<p>The name of the access policy.</p>" } } }, @@ -1636,17 +1636,17 @@ "shape":"AccessPolicyStats", "documentation":"<p>Information about the data access policies in your account.</p>" }, - "LifecyclePolicyStats":{ - "shape":"LifecyclePolicyStats", - "documentation":"<p>Information about the lifecycle policies in your account.</p>" + "SecurityPolicyStats":{ + "shape":"SecurityPolicyStats", + "documentation":"<p>Information about the security policies in your account.</p>" }, "SecurityConfigStats":{ "shape":"SecurityConfigStats", "documentation":"<p>Information about the security configurations in your account.</p>" }, - "SecurityPolicyStats":{ - "shape":"SecurityPolicyStats", - "documentation":"<p>Information about the security policies in your account.</p>" + "LifecyclePolicyStats":{ + "shape":"LifecyclePolicyStats", + "documentation":"<p>Information about the lifecycle policies in your account.</p>" }, "TotalPolicyCount":{ "shape":"Long", @@ -1676,17 +1676,17 @@ "GetSecurityPolicyRequest":{ "type":"structure", "required":[ - "name", - "type" + "type", + "name" ], "members":{ - "name":{ - "shape":"PolicyName", - "documentation":"<p>The name of the security policy.</p>" - }, "type":{ "shape":"SecurityPolicyType", "documentation":"<p>The type of security policy.</p>" + }, + "name":{ + "shape":"PolicyName", + "documentation":"<p>The name of the security policy.</p>" } } }, @@ -1703,34 +1703,34 @@ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}" }, "IamIdentityCenterConfigOptions":{ "type":"structure", "members":{ + "instanceArn":{ + "shape":"IamIdentityCenterInstanceArn", + "documentation":"<p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.</p>" + }, "applicationArn":{ "shape":"IamIdentityCenterApplicationArn", "documentation":"<p>The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.</p>" }, - "applicationDescription":{ - "shape":"String", - "documentation":"<p>The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.</p>" - }, "applicationName":{ "shape":"String", "documentation":"<p>The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.</p>" }, - "groupAttribute":{ - "shape":"IamIdentityCenterGroupAttribute", - "documentation":"<p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>" - }, - "instanceArn":{ - "shape":"IamIdentityCenterInstanceArn", - "documentation":"<p>The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.</p>" + "applicationDescription":{ + "shape":"String", + "documentation":"<p>The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.</p>" }, "userAttribute":{ "shape":"IamIdentityCenterUserAttribute", "documentation":"<p>The user attribute for this IAM Identity Center integration. Defaults to <code>UserId</code> </p>" + }, + "groupAttribute":{ + "shape":"IamIdentityCenterGroupAttribute", + "documentation":"<p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>" } }, "documentation":"<p>Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.</p>" @@ -1746,7 +1746,7 @@ "type":"string", "max":1224, "min":10, - "pattern":"^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + "pattern":"arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}" }, "IamIdentityCenterUserAttribute":{ "type":"string", @@ -1773,33 +1773,33 @@ "LifecyclePolicyDetail":{ "type":"structure", "members":{ - "createdDate":{ - "shape":"Long", - "documentation":"<p>The date the lifecycle policy was created.</p>" - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>The description of the lifecycle policy.</p>" - }, - "lastModifiedDate":{ - "shape":"Long", - "documentation":"<p>The timestamp of when the lifecycle policy was last modified.</p>" + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"<p>The type of lifecycle policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the lifecycle policy.</p>" }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"<p>The version of the lifecycle policy.</p>" + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>The description of the lifecycle policy.</p>" + }, "policy":{ "shape":"Document", "documentation":"<p>The JSON policy document without any whitespaces.</p>" }, - "policyVersion":{ - "shape":"PolicyVersion", - "documentation":"<p>The version of the lifecycle policy.</p>" + "createdDate":{ + "shape":"Long", + "documentation":"<p>The date the lifecycle policy was created.</p>" }, - "type":{ - "shape":"LifecyclePolicyType", - "documentation":"<p>The type of lifecycle policy.</p>" + "lastModifiedDate":{ + "shape":"Long", + "documentation":"<p>The timestamp of when the lifecycle policy was last modified.</p>" } }, "documentation":"<p>Details about an OpenSearch Serverless lifecycle policy.</p>" @@ -1811,21 +1811,21 @@ "LifecyclePolicyErrorDetail":{ "type":"structure", "members":{ - "errorCode":{ - "shape":"String", - "documentation":"<p>The error code for the request. For example, <code>NOT_FOUND</code>.</p>" - }, - "errorMessage":{ - "shape":"String", - "documentation":"<p>A description of the error. For example, <code>The specified Lifecycle Policy is not found</code>.</p>" + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"<p>The type of lifecycle policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the lifecycle policy.</p>" }, - "type":{ - "shape":"LifecyclePolicyType", - "documentation":"<p>The type of lifecycle policy.</p>" + "errorMessage":{ + "shape":"String", + "documentation":"<p>A description of the error. For example, <code>The specified Lifecycle Policy is not found</code>.</p>" + }, + "errorCode":{ + "shape":"String", + "documentation":"<p>The error code for the request. For example, <code>NOT_FOUND</code>.</p>" } }, "documentation":"<p>Error information for an OpenSearch Serverless request.</p>" @@ -1837,17 +1837,17 @@ "LifecyclePolicyIdentifier":{ "type":"structure", "required":[ - "name", - "type" + "type", + "name" ], "members":{ - "name":{ - "shape":"PolicyName", - "documentation":"<p>The name of the lifecycle policy.</p>" - }, "type":{ "shape":"LifecyclePolicyType", "documentation":"<p>The type of lifecycle policy.</p>" + }, + "name":{ + "shape":"PolicyName", + "documentation":"<p>The name of the lifecycle policy.</p>" } }, "documentation":"<p>The unique identifiers of policy types and policy names.</p>" @@ -1861,17 +1861,17 @@ "LifecyclePolicyResourceIdentifier":{ "type":"structure", "required":[ - "resource", - "type" + "type", + "resource" ], "members":{ - "resource":{ - "shape":"ResourceName", - "documentation":"<p>The name of the OpenSearch Serverless ilndex resource.</p>" - }, "type":{ "shape":"LifecyclePolicyType", "documentation":"<p>The type of lifecycle policy.</p>" + }, + "resource":{ + "shape":"ResourceName", + "documentation":"<p>The name of the OpenSearch Serverless ilndex resource.</p>" } }, "documentation":"<p>The unique identifiers of policy types and resource names.</p>" @@ -1899,17 +1899,9 @@ "LifecyclePolicySummary":{ "type":"structure", "members":{ - "createdDate":{ - "shape":"Long", - "documentation":"<p>The Epoch time when the lifecycle policy was created.</p>" - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>The description of the lifecycle policy.</p>" - }, - "lastModifiedDate":{ - "shape":"Long", - "documentation":"<p>The date and time when the lifecycle policy was last modified.</p>" + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"<p>The type of lifecycle policy.</p>" }, "name":{ "shape":"PolicyName", @@ -1919,9 +1911,17 @@ "shape":"PolicyVersion", "documentation":"<p>The version of the lifecycle policy.</p>" }, - "type":{ - "shape":"LifecyclePolicyType", - "documentation":"<p>The type of lifecycle policy.</p>" + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>The description of the lifecycle policy.</p>" + }, + "createdDate":{ + "shape":"Long", + "documentation":"<p>The Epoch time when the lifecycle policy was created.</p>" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"<p>The date and time when the lifecycle policy was last modified.</p>" } }, "documentation":"<p>A summary of the lifecycle policy.</p>" @@ -1935,21 +1935,21 @@ "type":"structure", "required":["type"], "members":{ - "maxResults":{ - "shape":"ListAccessPoliciesRequestMaxResultsInteger", - "documentation":"<p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>" - }, - "nextToken":{ - "shape":"String", - "documentation":"<p>If your initial <code>ListAccessPolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListAccessPolicies</code> operations, which returns results in the next page. </p>" + "type":{ + "shape":"AccessPolicyType", + "documentation":"<p>The type of access policy.</p>" }, "resource":{ "shape":"ListAccessPoliciesRequestResourceList", "documentation":"<p>Resource filters (can be collections or indexes) that policies can apply to.</p>" }, - "type":{ - "shape":"AccessPolicyType", - "documentation":"<p>The type of access policy.</p>" + "nextToken":{ + "shape":"String", + "documentation":"<p>If your initial <code>ListAccessPolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListAccessPolicies</code> operations, which returns results in the next page. </p>" + }, + "maxResults":{ + "shape":"ListAccessPoliciesRequestMaxResultsInteger", + "documentation":"<p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>" } } }, @@ -1985,13 +1985,13 @@ "shape":"CollectionFilters", "documentation":"<p> A list of filter names and values that you can use for requests.</p>" }, - "maxResults":{ - "shape":"ListCollectionsRequestMaxResultsInteger", - "documentation":"<p>The maximum number of results to return. Default is 20. You can use <code>nextToken</code> to get the next page of results.</p>" - }, "nextToken":{ "shape":"String", "documentation":"<p>If your initial <code>ListCollections</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListCollections</code> operations, which returns results in the next page.</p>" + }, + "maxResults":{ + "shape":"ListCollectionsRequestMaxResultsInteger", + "documentation":"<p>The maximum number of results to return. Default is 20. You can use <code>nextToken</code> to get the next page of results.</p>" } } }, @@ -2018,21 +2018,21 @@ "type":"structure", "required":["type"], "members":{ - "maxResults":{ - "shape":"ListLifecyclePoliciesRequestMaxResultsInteger", - "documentation":"<p>An optional parameter that specifies the maximum number of results to return. You can use use <code>nextToken</code> to get the next page of results. The default is 10.</p>" - }, - "nextToken":{ - "shape":"String", - "documentation":"<p>If your initial <code>ListLifecyclePolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListLifecyclePolicies</code> operations, which returns results in the next page.</p>" + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"<p>The type of lifecycle policy.</p>" }, "resources":{ "shape":"ListLifecyclePoliciesRequestResourcesList", "documentation":"<p>Resource filters that policies can apply to. Currently, the only supported resource type is <code>index</code>.</p>" }, - "type":{ - "shape":"LifecyclePolicyType", - "documentation":"<p>The type of lifecycle policy.</p>" + "nextToken":{ + "shape":"String", + "documentation":"<p>If your initial <code>ListLifecyclePolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListLifecyclePolicies</code> operations, which returns results in the next page.</p>" + }, + "maxResults":{ + "shape":"ListLifecyclePoliciesRequestMaxResultsInteger", + "documentation":"<p>An optional parameter that specifies the maximum number of results to return. You can use use <code>nextToken</code> to get the next page of results. The default is 10.</p>" } } }, @@ -2065,17 +2065,17 @@ "type":"structure", "required":["type"], "members":{ - "maxResults":{ - "shape":"ListSecurityConfigsRequestMaxResultsInteger", - "documentation":"<p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>" + "type":{ + "shape":"SecurityConfigType", + "documentation":"<p>The type of security configuration.</p>" }, "nextToken":{ "shape":"String", "documentation":"<p>If your initial <code>ListSecurityConfigs</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListSecurityConfigs</code> operations, which returns results in the next page. </p>" }, - "type":{ - "shape":"SecurityConfigType", - "documentation":"<p>The type of security configuration.</p>" + "maxResults":{ + "shape":"ListSecurityConfigsRequestMaxResultsInteger", + "documentation":"<p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>" } } }, @@ -2088,13 +2088,13 @@ "ListSecurityConfigsResponse":{ "type":"structure", "members":{ - "nextToken":{ - "shape":"String", - "documentation":"<p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>" - }, "securityConfigSummaries":{ "shape":"SecurityConfigSummaries", "documentation":"<p>Details about the security configurations in your account.</p>" + }, + "nextToken":{ + "shape":"String", + "documentation":"<p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>" } } }, @@ -2102,21 +2102,21 @@ "type":"structure", "required":["type"], "members":{ - "maxResults":{ - "shape":"ListSecurityPoliciesRequestMaxResultsInteger", - "documentation":"<p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>" - }, - "nextToken":{ - "shape":"String", - "documentation":"<p>If your initial <code>ListSecurityPolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListSecurityPolicies</code> operations, which returns results in the next page. </p>" + "type":{ + "shape":"SecurityPolicyType", + "documentation":"<p>The type of policy.</p>" }, "resource":{ "shape":"ListSecurityPoliciesRequestResourceList", "documentation":"<p>Resource filters (can be collection or indexes) that policies can apply to. </p>" }, - "type":{ - "shape":"SecurityPolicyType", - "documentation":"<p>The type of policy.</p>" + "nextToken":{ + "shape":"String", + "documentation":"<p>If your initial <code>ListSecurityPolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListSecurityPolicies</code> operations, which returns results in the next page. </p>" + }, + "maxResults":{ + "shape":"ListSecurityPoliciesRequestMaxResultsInteger", + "documentation":"<p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>" } } }, @@ -2135,13 +2135,13 @@ "ListSecurityPoliciesResponse":{ "type":"structure", "members":{ - "nextToken":{ - "shape":"String", - "documentation":"<p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>" - }, "securityPolicySummaries":{ "shape":"SecurityPolicySummaries", "documentation":"<p>Details about the security policies in your account.</p>" + }, + "nextToken":{ + "shape":"String", + "documentation":"<p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>" } } }, @@ -2167,17 +2167,17 @@ "ListVpcEndpointsRequest":{ "type":"structure", "members":{ - "maxResults":{ - "shape":"ListVpcEndpointsRequestMaxResultsInteger", - "documentation":"<p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>" + "vpcEndpointFilters":{ + "shape":"VpcEndpointFilters", + "documentation":"<p>Filter the results according to the current status of the VPC endpoint. Possible statuses are <code>CREATING</code>, <code>DELETING</code>, <code>UPDATING</code>, <code>ACTIVE</code>, and <code>FAILED</code>.</p>" }, "nextToken":{ "shape":"String", "documentation":"<p>If your initial <code>ListVpcEndpoints</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListVpcEndpoints</code> operations, which returns results in the next page. </p>" }, - "vpcEndpointFilters":{ - "shape":"VpcEndpointFilters", - "documentation":"<p>Filter the results according to the current status of the VPC endpoint. Possible statuses are <code>CREATING</code>, <code>DELETING</code>, <code>UPDATING</code>, <code>ACTIVE</code>, and <code>FAILED</code>.</p>" + "maxResults":{ + "shape":"ListVpcEndpointsRequestMaxResultsInteger", + "documentation":"<p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>" } } }, @@ -2190,13 +2190,13 @@ "ListVpcEndpointsResponse":{ "type":"structure", "members":{ - "nextToken":{ - "shape":"String", - "documentation":"<p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>" - }, "vpcEndpointSummaries":{ "shape":"VpcEndpointSummaries", "documentation":"<p>Details about each VPC endpoint, including the name and current status.</p>" + }, + "nextToken":{ + "shape":"String", + "documentation":"<p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>" } } }, @@ -2225,24 +2225,24 @@ "type":"string", "max":20480, "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" + "pattern":".*[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+.*" }, "PolicyName":{ "type":"string", "max":32, "min":3, - "pattern":"^[a-z][a-z0-9-]+$" + "pattern":"[a-z][a-z0-9-]+" }, "PolicyVersion":{ "type":"string", "max":36, "min":20, - "pattern":"^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$" + "pattern":"([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?" }, "Resource":{"type":"string"}, "ResourceName":{ "type":"string", - "pattern":"^index/[a-z][a-z0-9-]{3,32}/([a-z;0-9&$%][+.~=\\-_a-z;0-9&$%]*)$" + "pattern":"index/[a-z][a-z0-9-]{3,32}/([a-z;0-9&$%][+.~=\\-_a-z;0-9&$%]*)" }, "ResourceNotFoundException":{ "type":"structure", @@ -2260,21 +2260,25 @@ "type":"structure", "required":["metadata"], "members":{ + "metadata":{ + "shape":"samlMetadata", + "documentation":"<p>The XML IdP metadata file generated from your identity provider.</p>" + }, + "userAttribute":{ + "shape":"samlUserAttribute", + "documentation":"<p>A user attribute for this SAML integration.</p>" + }, "groupAttribute":{ "shape":"samlGroupAttribute", "documentation":"<p>The group attribute for this SAML integration.</p>" }, - "metadata":{ - "shape":"samlMetadata", - "documentation":"<p>The XML IdP metadata file generated from your identity provider.</p>" + "openSearchServerlessEntityId":{ + "shape":"openSearchServerlessEntityId", + "documentation":"<p>Custom entity id attribute to override default entity id for this saml integration.</p>" }, "sessionTimeout":{ "shape":"SamlConfigOptionsSessionTimeoutInteger", "documentation":"<p>The session timeout, in minutes. Default is 60 minutes (12 hours).</p>" - }, - "userAttribute":{ - "shape":"samlUserAttribute", - "documentation":"<p>A user attribute for this SAML integration.</p>" } }, "documentation":"<p>Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.</p>" @@ -2293,37 +2297,37 @@ "SecurityConfigDetail":{ "type":"structure", "members":{ + "id":{ + "shape":"SecurityConfigId", + "documentation":"<p>The unique identifier of the security configuration.</p>" + }, + "type":{ + "shape":"SecurityConfigType", + "documentation":"<p>The type of security configuration.</p>" + }, "configVersion":{ "shape":"PolicyVersion", "documentation":"<p>The version of the security configuration.</p>" }, - "createdDate":{ - "shape":"Long", - "documentation":"<p>The date the configuration was created.</p>" - }, "description":{ "shape":"ConfigDescription", "documentation":"<p>The description of the security configuration.</p>" }, + "samlOptions":{ + "shape":"SamlConfigOptions", + "documentation":"<p>SAML options for the security configuration in the form of a key-value map.</p>" + }, "iamIdentityCenterOptions":{ "shape":"IamIdentityCenterConfigOptions", "documentation":"<p>Describes IAM Identity Center options in the form of a key-value map.</p>" }, - "id":{ - "shape":"SecurityConfigId", - "documentation":"<p>The unique identifier of the security configuration.</p>" + "createdDate":{ + "shape":"Long", + "documentation":"<p>The date the configuration was created.</p>" }, "lastModifiedDate":{ "shape":"Long", "documentation":"<p>The timestamp of when the configuration was last modified.</p>" - }, - "samlOptions":{ - "shape":"SamlConfigOptions", - "documentation":"<p>SAML options for the security configuration in the form of a key-value map.</p>" - }, - "type":{ - "shape":"SecurityConfigType", - "documentation":"<p>The type of security configuration.</p>" } }, "documentation":"<p>Details about a security configuration for OpenSearch Serverless. </p>" @@ -2350,29 +2354,29 @@ "SecurityConfigSummary":{ "type":"structure", "members":{ + "id":{ + "shape":"SecurityConfigId", + "documentation":"<p>The unique identifier of the security configuration.</p>" + }, + "type":{ + "shape":"SecurityConfigType", + "documentation":"<p>The type of security configuration.</p>" + }, "configVersion":{ "shape":"PolicyVersion", "documentation":"<p>The version of the security configuration.</p>" }, - "createdDate":{ - "shape":"Long", - "documentation":"<p>The Epoch time when the security configuration was created.</p>" - }, "description":{ "shape":"ConfigDescription", "documentation":"<p>The description of the security configuration.</p>" }, - "id":{ - "shape":"SecurityConfigId", - "documentation":"<p>The unique identifier of the security configuration.</p>" + "createdDate":{ + "shape":"Long", + "documentation":"<p>The Epoch time when the security configuration was created.</p>" }, "lastModifiedDate":{ "shape":"Long", "documentation":"<p>The timestamp of when the configuration was last modified.</p>" - }, - "type":{ - "shape":"SecurityConfigType", - "documentation":"<p>The type of security configuration.</p>" } }, "documentation":"<p>A summary of a security configuration for OpenSearch Serverless.</p>" @@ -2388,7 +2392,7 @@ "type":"string", "max":128, "min":1, - "pattern":"^[\\w+\\-]+$" + "pattern":"[\\w+\\-]+" }, "SecurityGroupIds":{ "type":"list", @@ -2399,33 +2403,33 @@ "SecurityPolicyDetail":{ "type":"structure", "members":{ - "createdDate":{ - "shape":"Long", - "documentation":"<p>The date the policy was created.</p>" - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>The description of the security policy.</p>" - }, - "lastModifiedDate":{ - "shape":"Long", - "documentation":"<p>The timestamp of when the policy was last modified.</p>" + "type":{ + "shape":"SecurityPolicyType", + "documentation":"<p>The type of security policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the policy.</p>" }, + "policyVersion":{ + "shape":"PolicyVersion", + "documentation":"<p>The version of the policy.</p>" + }, + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>The description of the security policy.</p>" + }, "policy":{ "shape":"Document", "documentation":"<p>The JSON policy document without any whitespaces.</p>" }, - "policyVersion":{ - "shape":"PolicyVersion", - "documentation":"<p>The version of the policy.</p>" + "createdDate":{ + "shape":"Long", + "documentation":"<p>The date the policy was created.</p>" }, - "type":{ - "shape":"SecurityPolicyType", - "documentation":"<p>The type of security policy.</p>" + "lastModifiedDate":{ + "shape":"Long", + "documentation":"<p>The timestamp of when the policy was last modified.</p>" } }, "documentation":"<p>Details about an OpenSearch Serverless security policy.</p>" @@ -2451,17 +2455,9 @@ "SecurityPolicySummary":{ "type":"structure", "members":{ - "createdDate":{ - "shape":"Long", - "documentation":"<p>The date the policy was created.</p>" - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>The description of the security policy.</p>" - }, - "lastModifiedDate":{ - "shape":"Long", - "documentation":"<p>The timestamp of when the policy was last modified.</p>" + "type":{ + "shape":"SecurityPolicyType", + "documentation":"<p>The type of security policy.</p>" }, "name":{ "shape":"PolicyName", @@ -2471,9 +2467,17 @@ "shape":"PolicyVersion", "documentation":"<p>The version of the policy.</p>" }, - "type":{ - "shape":"SecurityPolicyType", - "documentation":"<p>The type of security policy.</p>" + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>The description of the security policy.</p>" + }, + "createdDate":{ + "shape":"Long", + "documentation":"<p>The date the policy was created.</p>" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"<p>The timestamp of when the policy was last modified.</p>" } }, "documentation":"<p>A summary of a security policy for OpenSearch Serverless.</p>" @@ -2496,10 +2500,6 @@ "shape":"String", "documentation":"<p>Description of the error.</p>" }, - "quotaCode":{ - "shape":"String", - "documentation":"<p>Service Quotas requirement to identify originating quota.</p>" - }, "resourceId":{ "shape":"String", "documentation":"<p>Identifier of the resource affected.</p>" @@ -2511,6 +2511,10 @@ "serviceCode":{ "shape":"String", "documentation":"<p>Service Quotas requirement to identify originating service.</p>" + }, + "quotaCode":{ + "shape":"String", + "documentation":"<p>Service Quotas requirement to identify originating quota.</p>" } }, "documentation":"<p>Thrown when you attempt to create more resources than the service allows based on service quotas.</p>", @@ -2528,7 +2532,7 @@ "type":"string", "max":32, "min":1, - "pattern":"^subnet-([0-9a-f]{8}|[0-9a-f]{17})$" + "pattern":"subnet-([0-9a-f]{8}|[0-9a-f]{17})" }, "SubnetIds":{ "type":"list", @@ -2623,35 +2627,35 @@ "UpdateAccessPolicyRequest":{ "type":"structure", "required":[ + "type", "name", - "policyVersion", - "type" + "policyVersion" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>" + "type":{ + "shape":"AccessPolicyType", + "documentation":"<p>The type of policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the policy.</p>" }, - "policy":{ - "shape":"PolicyDocument", - "documentation":"<p>The JSON policy document to use as the content for the policy.</p>" - }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"<p>The version of the policy being updated.</p>" }, - "type":{ - "shape":"AccessPolicyType", - "documentation":"<p>The type of policy.</p>" + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"<p>The JSON policy document to use as the content for the policy.</p>" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -2682,26 +2686,10 @@ "UpdateCollectionDetail":{ "type":"structure", "members":{ - "arn":{ - "shape":"String", - "documentation":"<p>The Amazon Resource Name (ARN) of the collection.</p>" - }, - "createdDate":{ - "shape":"Long", - "documentation":"<p>The date and time when the collection was created.</p>" - }, - "description":{ - "shape":"String", - "documentation":"<p>The description of the collection.</p>" - }, "id":{ "shape":"CollectionId", "documentation":"<p>The unique identifier of the collection.</p>" }, - "lastModifiedDate":{ - "shape":"Long", - "documentation":"<p>The date and time when the collection was last modified.</p>" - }, "name":{ "shape":"CollectionName", "documentation":"<p>The name of the collection.</p>" @@ -2713,6 +2701,22 @@ "type":{ "shape":"CollectionType", "documentation":"<p>The collection type.</p>" + }, + "description":{ + "shape":"String", + "documentation":"<p>The description of the collection.</p>" + }, + "arn":{ + "shape":"String", + "documentation":"<p>The Amazon Resource Name (ARN) of the collection.</p>" + }, + "createdDate":{ + "shape":"Long", + "documentation":"<p>The date and time when the collection was created.</p>" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"<p>The date and time when the collection was last modified.</p>" } }, "documentation":"<p>Details about an updated OpenSearch Serverless collection.</p>" @@ -2721,18 +2725,18 @@ "type":"structure", "required":["id"], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true + "id":{ + "shape":"CollectionId", + "documentation":"<p>The unique identifier of the collection.</p>" }, "description":{ "shape":"UpdateCollectionRequestDescriptionString", "documentation":"<p>A description of the collection.</p>" }, - "id":{ - "shape":"CollectionId", - "documentation":"<p>The unique identifier of the collection.</p>" + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -2753,13 +2757,13 @@ "UpdateIamIdentityCenterConfigOptions":{ "type":"structure", "members":{ - "groupAttribute":{ - "shape":"IamIdentityCenterGroupAttribute", - "documentation":"<p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>" - }, "userAttribute":{ "shape":"IamIdentityCenterUserAttribute", "documentation":"<p>The user attribute for this IAM Identity Center integration. Defaults to <code>UserId</code>.</p>" + }, + "groupAttribute":{ + "shape":"IamIdentityCenterGroupAttribute", + "documentation":"<p>The group attribute for this IAM Identity Center integration. Defaults to <code>GroupId</code>.</p>" } }, "documentation":"<p>Describes IAM Identity Center options for updating an OpenSearch Serverless security configuration in the form of a key-value map.</p>" @@ -2767,35 +2771,35 @@ "UpdateLifecyclePolicyRequest":{ "type":"structure", "required":[ + "type", "name", - "policyVersion", - "type" + "policyVersion" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>A description of the lifecycle policy.</p>" + "type":{ + "shape":"LifecyclePolicyType", + "documentation":"<p> The type of lifecycle policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the policy.</p>" }, - "policy":{ - "shape":"PolicyDocument", - "documentation":"<p>The JSON policy document to use as the content for the lifecycle policy.</p>" - }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"<p>The version of the policy being updated.</p>" }, - "type":{ - "shape":"LifecyclePolicyType", - "documentation":"<p> The type of lifecycle policy.</p>" + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>A description of the lifecycle policy.</p>" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"<p>The JSON policy document to use as the content for the lifecycle policy.</p>" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -2811,14 +2815,13 @@ "UpdateSecurityConfigRequest":{ "type":"structure", "required":[ - "configVersion", - "id" + "id", + "configVersion" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true + "id":{ + "shape":"SecurityConfigId", + "documentation":"<p>The security configuration identifier. For SAML the ID will be <code>saml/<accountId>/<idpProviderName></code>. For example, <code>saml/123456789123/OKTADev</code>.</p>" }, "configVersion":{ "shape":"PolicyVersion", @@ -2828,17 +2831,18 @@ "shape":"ConfigDescription", "documentation":"<p>A description of the security configuration.</p>" }, + "samlOptions":{ + "shape":"SamlConfigOptions", + "documentation":"<p>SAML options in in the form of a key-value map.</p>" + }, "iamIdentityCenterOptionsUpdates":{ "shape":"UpdateIamIdentityCenterConfigOptions", "documentation":"<p>Describes IAM Identity Center options in the form of a key-value map.</p>" }, - "id":{ - "shape":"SecurityConfigId", - "documentation":"<p>The security configuration identifier. For SAML the ID will be <code>saml/<accountId>/<idpProviderName></code>. For example, <code>saml/123456789123/OKTADev</code>.</p>" - }, - "samlOptions":{ - "shape":"SamlConfigOptions", - "documentation":"<p>SAML options in in the form of a key-value map.</p>" + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -2854,35 +2858,35 @@ "UpdateSecurityPolicyRequest":{ "type":"structure", "required":[ + "type", "name", - "policyVersion", - "type" + "policyVersion" ], "members":{ - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true - }, - "description":{ - "shape":"PolicyDescription", - "documentation":"<p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>" + "type":{ + "shape":"SecurityPolicyType", + "documentation":"<p>The type of access policy.</p>" }, "name":{ "shape":"PolicyName", "documentation":"<p>The name of the policy.</p>" }, - "policy":{ - "shape":"PolicyDocument", - "documentation":"<p>The JSON policy document to use as the content for the new policy.</p>" - }, "policyVersion":{ "shape":"PolicyVersion", "documentation":"<p>The version of the policy being updated.</p>" }, - "type":{ - "shape":"SecurityPolicyType", - "documentation":"<p>The type of access policy.</p>" + "description":{ + "shape":"PolicyDescription", + "documentation":"<p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>" + }, + "policy":{ + "shape":"PolicyDocument", + "documentation":"<p>The JSON policy document to use as the content for the new policy.</p>" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -2902,18 +2906,10 @@ "shape":"VpcEndpointId", "documentation":"<p>The unique identifier of the endpoint.</p>" }, - "lastModifiedDate":{ - "shape":"Long", - "documentation":"<p>The timestamp of when the endpoint was last modified.</p>" - }, "name":{ "shape":"VpcEndpointName", "documentation":"<p>The name of the endpoint.</p>" }, - "securityGroupIds":{ - "shape":"SecurityGroupIds", - "documentation":"<p>The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>" - }, "status":{ "shape":"VpcEndpointStatus", "documentation":"<p>The current status of the endpoint update process.</p>" @@ -2921,6 +2917,14 @@ "subnetIds":{ "shape":"SubnetIds", "documentation":"<p>The ID of the subnets from which you access OpenSearch Serverless.</p>" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"<p>The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>" + }, + "lastModifiedDate":{ + "shape":"Long", + "documentation":"<p>The timestamp of when the endpoint was last modified.</p>" } }, "documentation":"<p>Update details for an OpenSearch Serverless-managed interface endpoint.</p>" @@ -2929,30 +2933,30 @@ "type":"structure", "required":["id"], "members":{ - "addSecurityGroupIds":{ - "shape":"SecurityGroupIds", - "documentation":"<p>The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>" + "id":{ + "shape":"VpcEndpointId", + "documentation":"<p>The unique identifier of the interface endpoint to update.</p>" }, "addSubnetIds":{ "shape":"SubnetIds", "documentation":"<p>The ID of one or more subnets to add to the endpoint.</p>" }, - "clientToken":{ - "shape":"ClientToken", - "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", - "idempotencyToken":true + "removeSubnetIds":{ + "shape":"SubnetIds", + "documentation":"<p>The unique identifiers of the subnets to remove from the endpoint.</p>" }, - "id":{ - "shape":"VpcEndpointId", - "documentation":"<p>The unique identifier of the interface endpoint to update.</p>" + "addSecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"<p>The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>" }, "removeSecurityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"<p>The unique identifiers of the security groups to remove from the endpoint.</p>" }, - "removeSubnetIds":{ - "shape":"SubnetIds", - "documentation":"<p>The unique identifiers of the subnets to remove from the endpoint.</p>" + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>", + "idempotencyToken":true } } }, @@ -2976,18 +2980,6 @@ "VpcEndpointDetail":{ "type":"structure", "members":{ - "createdDate":{ - "shape":"Long", - "documentation":"<p>The date the endpoint was created.</p>" - }, - "failureCode":{ - "shape":"String", - "documentation":"<p>A failure code associated with the request.</p>" - }, - "failureMessage":{ - "shape":"String", - "documentation":"<p>A message associated with the failure code.</p>" - }, "id":{ "shape":"VpcEndpointId", "documentation":"<p>The unique identifier of the endpoint.</p>" @@ -2996,6 +2988,14 @@ "shape":"VpcEndpointName", "documentation":"<p>The name of the endpoint.</p>" }, + "vpcId":{ + "shape":"VpcId", + "documentation":"<p>The ID of the VPC from which you access OpenSearch Serverless.</p>" + }, + "subnetIds":{ + "shape":"SubnetIds", + "documentation":"<p>The ID of the subnets from which you access OpenSearch Serverless.</p>" + }, "securityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"<p>The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.</p>" @@ -3004,13 +3004,17 @@ "shape":"VpcEndpointStatus", "documentation":"<p>The current status of the endpoint.</p>" }, - "subnetIds":{ - "shape":"SubnetIds", - "documentation":"<p>The ID of the subnets from which you access OpenSearch Serverless.</p>" + "createdDate":{ + "shape":"Long", + "documentation":"<p>The date the endpoint was created.</p>" }, - "vpcId":{ - "shape":"VpcId", - "documentation":"<p>The ID of the VPC from which you access OpenSearch Serverless.</p>" + "failureCode":{ + "shape":"String", + "documentation":"<p>A failure code associated with the request.</p>" + }, + "failureMessage":{ + "shape":"String", + "documentation":"<p>A message associated with the failure code.</p>" } }, "documentation":"<p>Details about an OpenSearch Serverless-managed interface endpoint.</p>" @@ -3022,17 +3026,17 @@ "VpcEndpointErrorDetail":{ "type":"structure", "members":{ - "errorCode":{ - "shape":"String", - "documentation":"<p>The error code for the failed request.</p>" + "id":{ + "shape":"VpcEndpointId", + "documentation":"<p>The unique identifier of the VPC endpoint.</p>" }, "errorMessage":{ "shape":"String", "documentation":"<p>An error message describing the reason for the failure.</p>" }, - "id":{ - "shape":"VpcEndpointId", - "documentation":"<p>The unique identifier of the VPC endpoint.</p>" + "errorCode":{ + "shape":"String", + "documentation":"<p>The error code for the failed request.</p>" } }, "documentation":"<p>Error information for a failed <code>BatchGetVpcEndpoint</code> request.</p>" @@ -3055,18 +3059,19 @@ "type":"string", "max":255, "min":1, - "pattern":"^vpce-[0-9a-z]*$" + "pattern":"vpce-[0-9a-z]*" }, "VpcEndpointIds":{ "type":"list", "member":{"shape":"VpcEndpointId"}, + "max":100, "min":1 }, "VpcEndpointName":{ "type":"string", "max":32, "min":3, - "pattern":"^[a-z][a-z0-9-]+$" + "pattern":"[a-z][a-z0-9-]+" }, "VpcEndpointStatus":{ "type":"string", @@ -3103,25 +3108,31 @@ "type":"string", "max":255, "min":1, - "pattern":"^vpc-[0-9a-z]*$" + "pattern":"vpc-[0-9a-z]*" + }, + "openSearchServerlessEntityId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"aws:opensearch:[0-9]{12}:*.*" }, "samlGroupAttribute":{ "type":"string", "max":2048, "min":1, - "pattern":"[\\w+=,.@-]+" + "pattern":".*[\\w+=,.@-]+.*" }, "samlMetadata":{ "type":"string", "max":51200, "min":1, - "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+" + "pattern":".*[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u00A1-\\u00FF]+.*" }, "samlUserAttribute":{ "type":"string", "max":2048, "min":1, - "pattern":"[\\w+=,.@-]+" + "pattern":".*[\\w+=,.@-]+.*" } }, "documentation":"<p>Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.</p> <p>OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.</p> <p> To learn more about OpenSearch Serverless, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html\">What is Amazon OpenSearch Serverless?</a> </p>" diff --git a/contrib/python/botocore/py3/botocore/data/opensearchserverless/2021-11-01/waiters-2.json b/contrib/python/botocore/py3/botocore/data/opensearchserverless/2021-11-01/waiters-2.json new file mode 100644 index 00000000000..13f60ee66be --- /dev/null +++ b/contrib/python/botocore/py3/botocore/data/opensearchserverless/2021-11-01/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/contrib/python/botocore/py3/botocore/data/partitions.json b/contrib/python/botocore/py3/botocore/data/partitions.json index 0066ea164ee..e19224f1b86 100644 --- a/contrib/python/botocore/py3/botocore/data/partitions.json +++ b/contrib/python/botocore/py3/botocore/data/partitions.json @@ -92,6 +92,9 @@ "me-south-1" : { "description" : "Middle East (Bahrain)" }, + "mx-central-1" : { + "description" : "Mexico (Central)" + }, "sa-east-1" : { "description" : "South America (Sao Paulo)" }, @@ -220,7 +223,17 @@ "supportsFIPS" : true }, "regionRegex" : "^us\\-isof\\-\\w+\\-\\d+$", - "regions" : { } + "regions" : { + "aws-iso-f-global" : { + "description" : "AWS ISOF global region" + }, + "us-isof-east-1" : { + "description" : "US ISOF EAST" + }, + "us-isof-south-1" : { + "description" : "US ISOF SOUTH" + } + } } ], "version" : "1.1" }
\ No newline at end of file diff --git a/contrib/python/botocore/py3/botocore/data/partnercentral-selling/2022-07-26/service-2.json b/contrib/python/botocore/py3/botocore/data/partnercentral-selling/2022-07-26/service-2.json index 5f6f7dfe23c..02f9b793bde 100644 --- a/contrib/python/botocore/py3/botocore/data/partnercentral-selling/2022-07-26/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/partnercentral-selling/2022-07-26/service-2.json @@ -24,12 +24,13 @@ "input":{"shape":"AcceptEngagementInvitationRequest"}, "errors":[ {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> Use the <code>AcceptEngagementInvitation</code> action to accept an engagement invitation shared by AWS. Accepting the invitation indicates your willingness to participate in the engagement, granting you access to all engagement-related data. </p>" + "documentation":"<p>Use the <code>AcceptEngagementInvitation</code> action to accept an engagement invitation shared by AWS. Accepting the invitation indicates your willingness to participate in the engagement, granting you access to all engagement-related data.</p>" }, "AssignOpportunity":{ "name":"AssignOpportunity", @@ -79,7 +80,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> The <code>CreateEngagement</code> action allows you to create an <code>Engagement</code>, which serves as a collaborative space between different parties such as AWS Partners and AWS Sellers. This action automatically adds the caller's AWS account as an active member of the newly created <code>Engagement</code>. </p>", + "documentation":"<p>The <code>CreateEngagement</code> action allows you to create an <code>Engagement</code>, which serves as a collaborative space between different parties such as AWS Partners and AWS Sellers. This action automatically adds the caller's AWS account as an active member of the newly created <code>Engagement</code>.</p>", "idempotent":true }, "CreateEngagementInvitation":{ @@ -117,7 +118,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p>Creates an <code>Opportunity</code> record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets <code>Lifecycle.ReviewStatus</code> to <code>Pending Submission</code>.</p> <p>To submit an opportunity, follow these steps:</p> <ol> <li> <p>To create the opportunity, use <code>CreateOpportunity</code>.</p> </li> <li> <p>To associate a solution with the opportunity, use <code>AssociateOpportunity</code>.</p> </li> <li> <p>To submit the opportunity, use <code>StartEngagementFromOpportunityTask</code>.</p> </li> </ol> <p>After submission, you can't edit the opportunity until the review is complete. But opportunities in the <code>Pending Submission</code> state must have complete details. You can update the opportunity while it's in the <code>Pending Submission</code> state.</p> <p>There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.</p>", + "documentation":"<p>Creates an <code>Opportunity</code> record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets <code>Lifecycle.ReviewStatus</code> to <code>Pending Submission</code>.</p> <p>To submit an opportunity, follow these steps:</p> <ol> <li> <p>To create the opportunity, use <code>CreateOpportunity</code>.</p> </li> <li> <p>To associate a solution with the opportunity, use <code>AssociateOpportunity</code>.</p> </li> <li> <p>To start the engagement with AWS, use <code>StartEngagementFromOpportunity</code>.</p> </li> </ol> <p>After submission, you can't edit the opportunity until the review is complete. But opportunities in the <code>Pending Submission</code> state must have complete details. You can update the opportunity while it's in the <code>Pending Submission</code> state.</p> <p>There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.</p>", "idempotent":true }, "CreateResourceSnapshot":{ @@ -155,7 +156,7 @@ {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> Use this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation. </p>", + "documentation":"<p>Use this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation.</p>", "idempotent":true }, "DeleteResourceSnapshotJob":{ @@ -167,6 +168,7 @@ "input":{"shape":"DeleteResourceSnapshotJobRequest"}, "errors":[ {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} @@ -221,7 +223,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> Use this action to retrieve the engagement record for a given <code>EngagementIdentifier</code>. </p>" + "documentation":"<p>Use this action to retrieve the engagement record for a given <code>EngagementIdentifier</code>.</p>" }, "GetEngagementInvitation":{ "name":"GetEngagementInvitation", @@ -287,7 +289,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> Use this action to retrieves information about a specific resource snapshot job. </p>" + "documentation":"<p>Use this action to retrieves information about a specific resource snapshot job.</p>" }, "GetSellingSystemSettings":{ "name":"GetSellingSystemSettings", @@ -368,7 +370,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> Retrieves the details of member partners in an engagement. This operation can only be invoked by members of the engagement. The <code>ListEngagementMembers</code> operation allows you to fetch information about the members of a specific engagement. This action is restricted to members of the engagement being queried. </p>" + "documentation":"<p>Retrieves the details of member partners in an Engagement. This operation can only be invoked by members of the Engagement. The <code>ListEngagementMembers</code> operation allows you to fetch information about the members of a specific Engagement. This action is restricted to members of the Engagement being queried. </p>" }, "ListEngagementResourceAssociations":{ "name":"ListEngagementResourceAssociations", @@ -384,7 +386,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement. </p>" + "documentation":"<p>Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.</p>" }, "ListEngagements":{ "name":"ListEngagements", @@ -400,7 +402,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> This action allows users to retrieve a list of engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process. </p>" + "documentation":"<p>This action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process. </p>" }, "ListOpportunities":{ "name":"ListOpportunities", @@ -430,7 +432,8 @@ "errors":[ {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, - {"shape":"ValidationException"} + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} ], "documentation":"<p> Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters. </p>" }, @@ -448,7 +451,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> Retrieves a list of resource view snapshots based on specified criteria. </p>" + "documentation":"<p>Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including: </p> <ul> <li> <p>Fetching all snapshots associated with an engagement.</p> </li> <li> <p>Retrieving snapshots of a specific resource type within an engagement.</p> </li> <li> <p>Obtaining snapshots for a particular resource using a specified template.</p> </li> <li> <p>Accessing the latest snapshot of a resource within an engagement.</p> </li> <li> <p>Filtering snapshots by resource owner.</p> </li> </ul>" }, "ListSolutions":{ "name":"ListSolutions", @@ -466,6 +469,23 @@ ], "documentation":"<p>Retrieves a list of Partner Solutions that the partner registered on Partner Central. This API is used to generate a list of solutions that an end user selects from for association with an opportunity.</p>" }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Returns a list of tags for a resource.</p>" + }, "PutSellingSystemSettings":{ "name":"PutSellingSystemSettings", "http":{ @@ -492,6 +512,7 @@ "input":{"shape":"RejectEngagementInvitationRequest"}, "errors":[ {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, @@ -550,7 +571,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> Starts a resource snapshot job that has been previously created. </p>", + "documentation":"<p>Starts a resource snapshot job that has been previously created.</p>", "idempotent":true }, "StopResourceSnapshotJob":{ @@ -566,7 +587,7 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> Stops a resource snapshot job. The job must be started prior to being stopped. </p>", + "documentation":"<p>Stops a resource snapshot job. The job must be started prior to being stopped.</p>", "idempotent":true }, "SubmitOpportunity":{ @@ -583,7 +604,45 @@ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"<p> Use this action to submit an opportunity that was previously created by partner for AWS review. After you perform this action, the opportunity becomes non-editable until it is reviewed by AWS and has <code> LifeCycle.ReviewStatus </code> as either <code>Approved</code> or <code>Action Required</code>. </p>" + "documentation":"<p>Use this action to submit an Opportunity that was previously created by partner for AWS review. After you perform this action, the Opportunity becomes non-editable until it is reviewed by AWS and has <code> LifeCycle.ReviewStatus </code> as either <code>Approved</code> or <code>Action Required</code>. </p>" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Assigns one or more tags (key-value pairs) to the specified resource.</p>", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"<p>Removes a tag or tags from a resource.</p>", + "idempotent":true }, "UpdateOpportunity":{ "name":"UpdateOpportunity", @@ -614,7 +673,7 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> The <code>CatalogType</code> parameter specifies the catalog associated with the engagement invitation. Accepted values are <code>AWS</code> and <code>Sandbox</code>, which determine the environment in which the engagement invitation is managed. </p>" + "documentation":"<p>The <code>CatalogType</code> parameter specifies the catalog associated with the engagement invitation. Accepted values are <code>AWS</code> and <code>Sandbox</code>, which determine the environment in which the engagement invitation is managed.</p>" }, "Identifier":{ "shape":"EngagementInvitationArnOrIdentifier", @@ -1624,24 +1683,24 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> The <code>CreateEngagementRequest$Catalog</code> parameter specifies the catalog related to the engagement. Accepted values are <code>AWS</code> and <code>Sandbox</code>, which determine the environment in which the engagement is managed. </p>" + "documentation":"<p>The <code>CreateEngagementRequest$Catalog</code> parameter specifies the catalog related to the engagement. Accepted values are <code>AWS</code> and <code>Sandbox</code>, which determine the environment in which the engagement is managed.</p>" }, "ClientToken":{ "shape":"CreateEngagementRequestClientTokenString", - "documentation":"<p> The <code>CreateEngagementRequest$ClientToken</code> parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters. </p>", + "documentation":"<p>The <code>CreateEngagementRequest$ClientToken</code> parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.</p>", "idempotencyToken":true }, "Contexts":{ "shape":"EngagementContexts", - "documentation":"<p> The <code>Contexts</code> field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a <code>Type</code> field indicating the context type, which must be <code>CustomerProject</code> in this version, and a <code>Payload</code> field containing the <code>CustomerProject</code> details. The <code>CustomerProject</code> object is composed of two main components: <code>Customer</code> and <code>Project</code>. The <code>Customer</code> object includes information such as <code>CompanyName</code>, <code>WebsiteUrl</code>, <code>Industry</code>, and <code>CountryCode</code>, providing essential details about the customer. The <code>Project</code> object contains <code>Title</code>, <code>BusinessProblem</code>, and <code>TargetCompletionDate</code>, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information. </p>" + "documentation":"<p>The <code>Contexts</code> field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a <code>Type</code> field indicating the context type, which must be <code>CustomerProject</code> in this version, and a <code>Payload</code> field containing the <code>CustomerProject</code> details. The <code>CustomerProject</code> object is composed of two main components: <code>Customer</code> and <code>Project</code>. The <code>Customer</code> object includes information such as <code>CompanyName</code>, <code>WebsiteUrl</code>, <code>Industry</code>, and <code>CountryCode</code>, providing essential details about the customer. The <code>Project</code> object contains <code>Title</code>, <code>BusinessProblem</code>, and <code>TargetCompletionDate</code>, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.</p>" }, "Description":{ "shape":"EngagementDescription", - "documentation":"<p> Provides a description of the <code>Engagement</code>. </p>" + "documentation":"<p>Provides a description of the <code>Engagement</code>.</p>" }, "Title":{ "shape":"EngagementTitle", - "documentation":"<p> Specifies the title of the <code>Engagement</code>. </p>" + "documentation":"<p>Specifies the title of the <code>Engagement</code>.</p>" } } }, @@ -1654,11 +1713,11 @@ "members":{ "Arn":{ "shape":"EngagementArn", - "documentation":"<p> The Amazon Resource Name (ARN) that identifies the engagement. </p>" + "documentation":"<p>The Amazon Resource Name (ARN) that identifies the engagement.</p>" }, "Id":{ "shape":"EngagementIdentifier", - "documentation":"<p> Unique identifier assigned to the newly created engagement. </p>" + "documentation":"<p>Unique identifier assigned to the newly created engagement.</p>" } } }, @@ -1712,7 +1771,7 @@ }, "PrimaryNeedsFromAws":{ "shape":"PrimaryNeedsFromAws", - "documentation":"<p>Identifies the type of support the partner needs from Amazon Web Services.</p> <p>Valid values:</p> <ul> <li> <p>Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.</p> </li> <li> <p>Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.</p> </li> <li> <p>Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.</p> </li> <li> <p>Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).</p> </li> <li> <p>Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.</p> </li> <li> <p>Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.</p> </li> <li> <p>Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).</p> </li> <li> <p>Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.</p> </li> <li> <p>Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycles. This is also known as a for-visibility-only (FVO) opportunity.</p> </li> </ul>" + "documentation":"<p>Identifies the type of support the partner needs from Amazon Web Services.</p> <p>Valid values:</p> <ul> <li> <p>Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.</p> </li> <li> <p>Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.</p> </li> <li> <p>Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.</p> </li> <li> <p>Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).</p> </li> <li> <p>Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.</p> </li> <li> <p>Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.</p> </li> <li> <p>Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).</p> </li> <li> <p>Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.</p> </li> </ul>" }, "Project":{ "shape":"Project", @@ -1764,28 +1823,32 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> Specifies the catalog in which to create the snapshot job. Valid values are <code>AWS</code> and <code> Sandbox</code>. </p>" + "documentation":"<p>Specifies the catalog in which to create the snapshot job. Valid values are <code>AWS</code> and <code> Sandbox</code>.</p>" }, "ClientToken":{ "shape":"CreateResourceSnapshotJobRequestClientTokenString", - "documentation":"<p> Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot job creations. </p>", + "documentation":"<p>A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.</p>", "idempotencyToken":true }, "EngagementIdentifier":{ "shape":"EngagementIdentifier", - "documentation":"<p> Specifies the identifier of the engagement associated with the resource to be snapshotted. </p>" + "documentation":"<p>Specifies the identifier of the engagement associated with the resource to be snapshotted.</p>" }, "ResourceIdentifier":{ "shape":"ResourceIdentifier", - "documentation":"<p> Specifies the identifier of the specific resource to be snapshotted. The format depends on the <code>ResourceType</code>. </p>" + "documentation":"<p>Specifies the identifier of the specific resource to be snapshotted. The format depends on the <code> ResourceType</code>.</p>" }, "ResourceSnapshotTemplateIdentifier":{ "shape":"ResourceTemplateName", - "documentation":"<p> Specifies the name of the template that defines the schema for the snapshot. </p>" + "documentation":"<p>Specifies the name of the template that defines the schema for the snapshot.</p>" }, "ResourceType":{ "shape":"ResourceType", - "documentation":"<p> The type of resource for which the snapshot job is being created. Must be one of the supported resource types <code>Opportunity</code>. </p>" + "documentation":"<p>The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. <code>Opportunity</code> </p>" + }, + "Tags":{ + "shape":"TagList", + "documentation":"<p>A list of objects specifying each tag name and value.</p>" } } }, @@ -1798,11 +1861,11 @@ "members":{ "Arn":{ "shape":"ResourceSnapshotJobArn", - "documentation":"<p> The Amazon Resource Name (ARN) of the created snapshot job. </p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the created snapshot job.</p>" }, "Id":{ "shape":"ResourceSnapshotJobIdentifier", - "documentation":"<p> The unique identifier for the created snapshot job. </p>" + "documentation":"<p>The unique identifier for the created snapshot job.</p>" } } }, @@ -2059,10 +2122,10 @@ "Customer":{"shape":"EngagementCustomer"}, "Project":{ "shape":"EngagementCustomerProjectDetails", - "documentation":"<p> Information about the customer project associated with the Engagement. </p>" + "documentation":"<p>Information about the customer project associated with the Engagement.</p>" } }, - "documentation":"<p> The CustomerProjects structure in Engagements offers a flexible framework for managing customer-project relationships. It supports multiple customers per Engagement and multiple projects per customer, while also allowing for customers without projects and projects without specific customers. </p> <p>All Engagement members have full visibility of customers and their associated projects, enabling the capture of relevant context even when project details are not fully defined. This structure also facilitates targeted invitations, allowing partners to focus on specific customers and their business problems when sending Engagement invitations. </p>" + "documentation":"<p>The CustomerProjects structure in Engagements offers a flexible framework for managing customer-project relationships. It supports multiple customers per Engagement and multiple projects per customer, while also allowing for customers without projects and projects without specific customers. </p> <p>All Engagement members have full visibility of customers and their associated projects, enabling the capture of relevant context even when project details are not fully defined. This structure also facilitates targeted invitations, allowing partners to focus on specific customers and their business problems when sending Engagement invitations. </p>" }, "CustomerSummary":{ "type":"structure", @@ -2172,24 +2235,24 @@ "members":{ "Payload":{ "shape":"EngagementContextPayload", - "documentation":"<p> Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field. </p>" + "documentation":"<p>Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field. </p>" }, "Type":{ "shape":"EngagementContextType", - "documentation":"<p> Specifies the type of Engagement context. Valid values are \"CustomerProject\" or \"Document\", indicating whether the context relates to a customer project or a document respectively. </p>" + "documentation":"<p>Specifies the type of Engagement context. Valid values are \"CustomerProject\" or \"Document\", indicating whether the context relates to a customer project or a document respectively. </p>" } }, - "documentation":"<p> Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload. </p>" + "documentation":"<p>Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload. </p>" }, "EngagementContextPayload":{ "type":"structure", "members":{ "CustomerProject":{ "shape":"CustomerProjectsContext", - "documentation":"<p> Contains detailed information about a customer project when the context type is \"CustomerProject\". This field is present only when the Type in EngagementContextDetails is set to \"CustomerProject\". </p>" + "documentation":"<p>Contains detailed information about a customer project when the context type is \"CustomerProject\". This field is present only when the Type in EngagementContextDetails is set to \"CustomerProject\". </p>" } }, - "documentation":"<p> Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails. </p>", + "documentation":"<p>Represents the payload of an Engagement context. The structure of this payload varies based on the context type specified in the EngagementContextDetails. </p>", "union":true }, "EngagementContextType":{ @@ -2246,18 +2309,18 @@ "members":{ "BusinessProblem":{ "shape":"EngagementCustomerBusinessProblem", - "documentation":"<p> A description of the business problem the project aims to solve. </p>" + "documentation":"<p>A description of the business problem the project aims to solve.</p>" }, "TargetCompletionDate":{ "shape":"EngagementCustomerProjectDetailsTargetCompletionDateString", - "documentation":"<p> The target completion date for the customer's project. </p>" + "documentation":"<p>The target completion date for the customer's project.</p>" }, "Title":{ "shape":"EngagementCustomerProjectTitle", - "documentation":"<p> The title of the project. </p>" + "documentation":"<p>The title of the project.</p>" } }, - "documentation":"<p> Provides comprehensive details about a customer project associated with an Engagement. This may include information such as project goals, timelines, and specific customer requirements. </p>" + "documentation":"<p>Provides comprehensive details about a customer project associated with an Engagement. This may include information such as project goals, timelines, and specific customer requirements. </p>" }, "EngagementCustomerProjectDetailsTargetCompletionDateString":{ "type":"string", @@ -2387,15 +2450,15 @@ "members":{ "AccountId":{ "shape":"AwsAccount", - "documentation":"<p> This is the unique identifier for the AWS account associated with the member organization. It's used for AWS-related operations and identity verification. </p>" + "documentation":"<p>This is the unique identifier for the AWS account associated with the member organization. It's used for AWS-related operations and identity verification. </p>" }, "CompanyName":{ "shape":"MemberCompanyName", - "documentation":"<p> The official name of the member's company or organization. </p>" + "documentation":"<p>The official name of the member's company or organization.</p>" }, "WebsiteUrl":{ "shape":"String", - "documentation":"<p> The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier. </p>" + "documentation":"<p>The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier. </p>" } }, "documentation":"<p>Engagement members are the participants in an Engagement, which is likely a collaborative project or business opportunity within the AWS partner network. Members can be different partner organizations or AWS accounts that are working together on a specific engagement. </p> <p>Each member is represented by their AWS Account ID, Company Name, and associated details. Members have a status within the Engagement (PENDING, ACCEPTED, REJECTED, or WITHDRAWN), indicating their current state of participation. Only existing members of an Engagement can view the list of other members. This implies a level of privacy and access control within the Engagement structure. </p>" @@ -2409,14 +2472,14 @@ "members":{ "CompanyName":{ "shape":"MemberCompanyName", - "documentation":"<p> The official name of the member's company or organization. </p>" + "documentation":"<p>The official name of the member's company or organization.</p>" }, "WebsiteUrl":{ "shape":"String", - "documentation":"<p> The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier. </p>" + "documentation":"<p>The URL of the member company's website. This offers a way to find more information about the member organization and serves as an additional identifier. </p>" } }, - "documentation":"<p> The EngagementMemberSummary provides a snapshot of essential information about participants in an AWS Partner Central Engagement. This compact data structure encapsulates key details of each member, facilitating efficient collaboration and management within the Engagement. </p>" + "documentation":"<p>The EngagementMemberSummary provides a snapshot of essential information about participants in an AWS Partner Central Engagement. This compact data structure encapsulates key details of each member, facilitating efficient collaboration and management within the Engagement. </p>" }, "EngagementMembers":{ "type":"list", @@ -2440,7 +2503,7 @@ }, "CreatedBy":{ "shape":"AwsAccount", - "documentation":"<p> The AWS account ID of the entity that created the association. </p>" + "documentation":"<p>The AWS account ID of the entity that owns the resource. Identifies the account responsible for or having primary control over the resource. </p>" }, "EngagementId":{ "shape":"EngagementIdentifier", @@ -2478,14 +2541,14 @@ "members":{ "SortBy":{ "shape":"EngagementSortName", - "documentation":"<p> The field by which to sort the results. </p>" + "documentation":"<p>The field by which to sort the results.</p>" }, "SortOrder":{ "shape":"SortOrder", - "documentation":"<p> The order in which to sort the results. </p>" + "documentation":"<p>The order in which to sort the results.</p>" } }, - "documentation":"<p> Specifies the sorting parameters for listing Engagements. </p>" + "documentation":"<p>Specifies the sorting parameters for listing Engagements.</p>" }, "EngagementSortName":{ "type":"string", @@ -2496,30 +2559,30 @@ "members":{ "Arn":{ "shape":"EngagementArn", - "documentation":"<p> The Amazon Resource Name (ARN) of the created engagement. </p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the created Engagement.</p>" }, "CreatedAt":{ "shape":"DateTime", - "documentation":"<p> The date and time when the engagement was created. </p>" + "documentation":"<p>The date and time when the Engagement was created.</p>" }, "CreatedBy":{ "shape":"AwsAccount", - "documentation":"<p> The AWS account ID of the engagement creator. </p>" + "documentation":"<p>The AWS Account ID of the Engagement creator.</p>" }, "Id":{ "shape":"EngagementIdentifier", - "documentation":"<p> The unique identifier for the engagement. </p>" + "documentation":"<p>The unique identifier for the Engagement.</p>" }, "MemberCount":{ "shape":"Integer", - "documentation":"<p> The number of members in the engagement. </p>" + "documentation":"<p>The number of members in the Engagement.</p>" }, "Title":{ "shape":"EngagementTitle", - "documentation":"<p> The title of the engagement. </p>" + "documentation":"<p>The title of the Engagement.</p>" } }, - "documentation":"<p> An object that contains an <code>Engagement</code>'s subset of fields. </p>" + "documentation":"<p>An object that contains an <code>Engagement</code>'s subset of fields. </p>" }, "EngagementSummaryList":{ "type":"list", @@ -2549,7 +2612,7 @@ }, "EstimationUrl":{ "shape":"WebsiteUrl", - "documentation":"<p> A URL providing additional information or context about the spend estimation. </p>" + "documentation":"<p>A URL providing additional information or context about the spend estimation.</p>" }, "Frequency":{ "shape":"PaymentFrequency", @@ -2852,11 +2915,11 @@ }, "EngagementDescription":{ "shape":"EngagementDescription", - "documentation":"<p> The description of the engagement associated with this invitation. </p>" + "documentation":"<p>The description of the engagement associated with this invitation.</p>" }, "EngagementId":{ "shape":"EngagementIdentifier", - "documentation":"<p> The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement. </p>" + "documentation":"<p>The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.</p>" }, "EngagementTitle":{ "shape":"EngagementTitle", @@ -2864,7 +2927,7 @@ }, "ExistingMembers":{ "shape":"EngagementMemberSummaries", - "documentation":"<p> A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties. </p> <ul> <li> <p> CompanyName: The name of the member's company. </p> </li> <li> <p> WebsiteUrl: The website URL of the member's company. </p> </li> </ul>" + "documentation":"<p>A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties.</p> <ul> <li> <p>CompanyName: The name of the member's company.</p> </li> <li> <p>WebsiteUrl: The website URL of the member's company.</p> </li> </ul>" }, "ExpirationDate":{ "shape":"DateTime", @@ -2880,7 +2943,7 @@ }, "InvitationMessage":{ "shape":"InvitationMessage", - "documentation":"<p> The message sent to the invited partner when the invitation was created. </p>" + "documentation":"<p>The message sent to the invited partner when the invitation was created.</p>" }, "Payload":{ "shape":"Payload", @@ -2926,11 +2989,11 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> Specifies the catalog related to the engagement request. Valid values are <code>AWS</code> and <code>Sandbox</code>. </p>" + "documentation":"<p>Specifies the catalog related to the engagement request. Valid values are <code>AWS</code> and <code>Sandbox</code>.</p>" }, "Identifier":{ "shape":"EngagementArnOrIdentifier", - "documentation":"<p> Specifies the identifier of the Engagement record to retrieve. </p>" + "documentation":"<p>Specifies the identifier of the Engagement record to retrieve.</p>" } } }, @@ -2939,35 +3002,35 @@ "members":{ "Arn":{ "shape":"EngagementArn", - "documentation":"<p> The Amazon Resource Name (ARN) of the engagement retrieved. </p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the engagement retrieved.</p>" }, "Contexts":{ "shape":"EngagementContexts", - "documentation":"<p> A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents. </p>" + "documentation":"<p>A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.</p>" }, "CreatedAt":{ "shape":"DateTime", - "documentation":"<p> The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: \"2023-05-01T20:37:46Z\". This timestamp helps track the lifecycle of the Engagement. </p>" + "documentation":"<p>The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: \"2023-05-01T20:37:46Z\". This timestamp helps track the lifecycle of the Engagement.</p>" }, "CreatedBy":{ "shape":"AwsAccount", - "documentation":"<p> The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement. </p>" + "documentation":"<p>The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.</p>" }, "Description":{ "shape":"EngagementDescription", - "documentation":"<p> A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope. </p>" + "documentation":"<p>A more detailed description of the engagement. This provides additional context or information about the engagement's purpose or scope.</p>" }, "Id":{ "shape":"EngagementIdentifier", - "documentation":"<p> The unique resource identifier of the engagement retrieved. </p>" + "documentation":"<p>The unique resource identifier of the engagement retrieved.</p>" }, "MemberCount":{ "shape":"Integer", - "documentation":"<p> Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement. </p>" + "documentation":"<p>Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.</p>" }, "Title":{ "shape":"EngagementTitle", - "documentation":"<p> The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable. </p>" + "documentation":"<p>The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.</p>" } } }, @@ -3048,7 +3111,7 @@ }, "PrimaryNeedsFromAws":{ "shape":"PrimaryNeedsFromAws", - "documentation":"<p>Identifies the type of support the partner needs from Amazon Web Services.</p> <p>Valid values:</p> <ul> <li> <p>Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.</p> </li> <li> <p>Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.</p> </li> <li> <p>Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.</p> </li> <li> <p>Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).</p> </li> <li> <p>Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.</p> </li> <li> <p>Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.</p> </li> <li> <p>Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).</p> </li> <li> <p>Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.</p> </li> <li> <p>Do Not Need Support from Amazon Web Services Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services sales representative, and the partner solely manages the opportunity. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.</p> </li> </ul>" + "documentation":"<p>Identifies the type of support the partner needs from Amazon Web Services.</p> <p>Valid values:</p> <ul> <li> <p>Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.</p> </li> <li> <p>Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.</p> </li> <li> <p>Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.</p> </li> <li> <p>Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).</p> </li> <li> <p>Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.</p> </li> <li> <p>Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.</p> </li> <li> <p>Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).</p> </li> <li> <p>Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.</p> </li> </ul>" }, "Project":{ "shape":"Project", @@ -3078,11 +3141,11 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> Specifies the catalog related to the request. Valid values are: </p> <ul> <li> <p> AWS: Retrieves the snapshot job from the production AWS environment. </p> </li> <li> <p> Sandbox: Retrieves the snapshot job from a sandbox environment used for testing or development purposes. </p> </li> </ul>" + "documentation":"<p>Specifies the catalog related to the request. Valid values are:</p> <ul> <li> <p> AWS: Retrieves the snapshot job from the production AWS environment. </p> </li> <li> <p> Sandbox: Retrieves the snapshot job from a sandbox environment used for testing or development purposes. </p> </li> </ul>" }, "ResourceSnapshotJobIdentifier":{ "shape":"ResourceSnapshotJobIdentifier", - "documentation":"<p> The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query. </p>" + "documentation":"<p>The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query. </p>" } } }, @@ -3092,51 +3155,51 @@ "members":{ "Arn":{ "shape":"ResourceSnapshotJobArn", - "documentation":"<p> he Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services. </p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services. </p>" }, "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> The catalog in which the snapshot job was created. This will match the catalog specified in the request. </p>" + "documentation":"<p>The catalog in which the snapshot job was created. This will match the Catalog specified in the request. </p>" }, "CreatedAt":{ "shape":"DateTime", - "documentation":"<p> The date and time when the snapshot job was created, in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\" </p>" + "documentation":"<p>The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\" </p>" }, "EngagementId":{ "shape":"EngagementIdentifier", - "documentation":"<p> The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context. </p>" + "documentation":"<p>The identifier of the engagement associated with this snapshot job. This links the job to a specific engagement context. </p>" }, "Id":{ "shape":"ResourceSnapshotJobIdentifier", - "documentation":"<p> The unique identifier of the snapshot job. This matches the <code>ResourceSnapshotJobIdentifier</code> provided in the request. </p>" + "documentation":"<p>The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request. </p>" }, "LastFailure":{ "shape":"String", - "documentation":"<p> If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job. </p>" + "documentation":"<p>If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job. </p>" }, "LastSuccessfulExecutionDate":{ "shape":"DateTime", - "documentation":"<p> The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\" </p>" + "documentation":"<p>The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: \"2023-05-01T20:37:46Z\" </p>" }, "ResourceArn":{ "shape":"ResourceArn", - "documentation":"<p> The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS. </p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS. </p>" }, "ResourceId":{ "shape":"ResourceIdentifier", - "documentation":"<p> The identifier of the specific resource being snapshotted. The format may vary depending on the <code>ResourceType</code>. </p>" + "documentation":"<p>The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType. </p>" }, "ResourceSnapshotTemplateName":{ "shape":"ResourceTemplateName", - "documentation":"<p> The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot. </p>" + "documentation":"<p>The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.</p>" }, "ResourceType":{ "shape":"ResourceType", - "documentation":"<p> The type of resource being snapshotted. This would have <code>Opportunity</code> as a value as it is dependent on the supported resource type. </p>" + "documentation":"<p>The type of resource being snapshotted. This would have \"Opportunity\" as a value as it is dependent on the supported resource type.</p>" }, "Status":{ "shape":"ResourceSnapshotJobStatus", - "documentation":"<p> The current status of the snapshot job. Valid values: </p> <ul> <li> <p> STOPPED: The job is not currently running. </p> </li> <li> <p> RUNNING: The job is actively executing. </p> </li> </ul>" + "documentation":"<p>The current status of the snapshot job. Valid values:</p> <ul> <li> <p>STOPPED: The job is not currently running.</p> </li> <li> <p>RUNNING: The job is actively executing.</p> </li> </ul>" } } }, @@ -3182,7 +3245,7 @@ "members":{ "Arn":{ "shape":"ResourceArn", - "documentation":"<p> The Amazon Resource Name (ARN) of the snapshot. This globally unique identifier can be used for resource-specific operations across AWS services. </p>" + "documentation":"<p>The Amazon Resource Name (ARN) that uniquely identifies the resource snapshot.</p>" }, "Catalog":{ "shape":"CatalogIdentifier", @@ -3203,19 +3266,19 @@ "Payload":{"shape":"ResourceSnapshotPayload"}, "ResourceId":{ "shape":"ResourceIdentifier", - "documentation":"<p> The identifier of the specific resource that was snapshotted. Matches the <code>ResourceIdentifier</code> specified in the request. </p>" + "documentation":"<p>The identifier of the specific resource that was snapshotted. Matches the ResourceIdentifier specified in the request.</p>" }, "ResourceSnapshotTemplateName":{ "shape":"ResourceTemplateName", - "documentation":"<p> The name of the view used for this snapshot. This is the same as the template name. </p>" + "documentation":"<p>The name of the view used for this snapshot. This is the same as the template name.</p>" }, "ResourceType":{ "shape":"ResourceType", - "documentation":"<p> The type of the resource that was snapshotted. Matches the <code>ResourceType</code> specified in the request. </p>" + "documentation":"<p>The type of the resource that was snapshotted. Matches the ResourceType specified in the request.</p>" }, "Revision":{ "shape":"ResourceSnapshotRevision", - "documentation":"<p> The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view. </p>" + "documentation":"<p>The revision number of this snapshot. This is a positive integer that is sequential and unique within the context of a resource view.</p>" } } }, @@ -3595,7 +3658,7 @@ }, "EngagementInvitationId":{ "shape":"EngagementInvitationIdentifier", - "documentation":"<p> The unique identifier of the engagement identifier created as a result of the task. This field is populated when the task is completed successfully. </p>" + "documentation":"<p>The unique identifier of the Engagement Invitation.</p>" }, "Message":{ "shape":"String", @@ -3761,19 +3824,19 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> The catalog related to the request. </p>" + "documentation":"<p>The catalog related to the request.</p>" }, "Identifier":{ "shape":"EngagementArnOrIdentifier", - "documentation":"<p> Identifier of the engagement record to retrieve members from. </p>" + "documentation":"<p>Identifier of the Engagement record to retrieve members from.</p>" }, "MaxResults":{ "shape":"MemberPageSize", - "documentation":"<p> The maximum number of results to return in a single call. </p>" + "documentation":"<p>The maximum number of results to return in a single call.</p>" }, "NextToken":{ "shape":"String", - "documentation":"<p> The token for the next set of results. </p>" + "documentation":"<p>The token for the next set of results.</p>" } } }, @@ -3787,7 +3850,7 @@ }, "NextToken":{ "shape":"String", - "documentation":"<p> A pagination token used to retrieve the next set of results. If there are more results available than can be returned in a single response, this token will be present. Use this token in a subsequent request to retrieve the next page of results. If there are no more results, this value will be null. </p>" + "documentation":"<p>A pagination token used to retrieve the next set of results. If there are more results available than can be returned in a single response, this token will be present. Use this token in a subsequent request to retrieve the next page of results. If there are no more results, this value will be null. </p>" } } }, @@ -3797,27 +3860,27 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> Specifies the catalog in which to search for engagement-resource associations. </p>" + "documentation":"<p>Specifies the catalog in which to search for engagement-resource associations. Valid Values: \"AWS\" or \"Sandbox\"</p> <ul> <li> <p> <code>AWS</code> for production environments.</p> </li> <li> <p> <code>Sandbox</code> for testing and development purposes.</p> </li> </ul>" }, "CreatedBy":{ "shape":"AwsAccount", - "documentation":"<p> Filters the results to include only associations with resources owned by the specified AWS account. Use this when you want to find associations related to resources owned by a particular account. </p>" + "documentation":"<p>Filters the response to include only snapshots of resources owned by the specified AWS account ID. Use this when you want to find associations related to resources owned by a particular account. </p>" }, "EngagementIdentifier":{ "shape":"EngagementIdentifier", - "documentation":"<p> Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement. </p>" + "documentation":"<p>Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement.</p>" }, "MaxResults":{ "shape":"ListEngagementResourceAssociationsRequestMaxResultsInteger", - "documentation":"<p> Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination. </p>" + "documentation":"<p>Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.</p>" }, "NextToken":{ "shape":"String", - "documentation":"<p> A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results. </p>" + "documentation":"<p>A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.</p>" }, "ResourceIdentifier":{ "shape":"ResourceIdentifier", - "documentation":"<p> Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource. </p>" + "documentation":"<p>Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource.</p>" }, "ResourceType":{ "shape":"ResourceType", @@ -3859,19 +3922,19 @@ }, "EngagementIdentifier":{ "shape":"EngagementIdentifiers", - "documentation":"<p> An array of strings representing engagement identifiers to retrieve. </p>" + "documentation":"<p>An array of strings representing engagement identifiers to retrieve.</p>" }, "ExcludeCreatedBy":{ "shape":"AwsAccountList", - "documentation":"<p> An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users. </p>" + "documentation":"<p>An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users. </p>" }, "MaxResults":{ "shape":"EngagementPageSize", - "documentation":"<p> The maximum number of results to return in a single call. </p>" + "documentation":"<p>The maximum number of results to return in a single call.</p>" }, "NextToken":{ "shape":"String", - "documentation":"<p> The token for the next set of results. This value is returned from a previous call. </p>" + "documentation":"<p>The token for the next set of results. This value is returned from a previous call.</p>" }, "Sort":{ "shape":"EngagementSort", @@ -3885,11 +3948,11 @@ "members":{ "EngagementSummaryList":{ "shape":"EngagementSummaryList", - "documentation":"<p> An array of engagement summary objects. </p>" + "documentation":"<p>An array of engagement summary objects.</p>" }, "NextToken":{ "shape":"String", - "documentation":"<p> The token to retrieve the next set of results. This field will be null if there are no more results. </p>" + "documentation":"<p>The token to retrieve the next set of results. This field will be null if there are no more results. </p>" } } }, @@ -4036,7 +4099,7 @@ }, "CreatedBy":{ "shape":"AwsAccount", - "documentation":"<p> Filters the response to include only snapshots of resources created by the specified AWS account. </p>" + "documentation":"<p>Filters the response to include only snapshots of resources owned by the specified AWS account. </p>" }, "EngagementIdentifier":{ "shape":"EngagementIdentifier", @@ -4056,7 +4119,7 @@ }, "ResourceSnapshotTemplateIdentifier":{ "shape":"ResourceTemplateName", - "documentation":"<p> Filters the response to include only snapshots created using the specified template. </p>" + "documentation":"<p>Filters the response to include only snapshots created using the specified template.</p>" }, "ResourceType":{ "shape":"ResourceType", @@ -4150,6 +4213,26 @@ } } }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"TaggableResourceArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.</p>" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"<p>A map of the key-value pairs for the tag or tags assigned to the specified resource.</p>" + } + } + }, "ListTasksSortBase":{ "type":"structure", "required":[ @@ -4731,12 +4814,12 @@ "EngagementConflict", "OpportunitySubmissionFailed", "EngagementInvitationConflict", + "InternalError", "OpportunityValidationFailed", "OpportunityConflict", "ResourceSnapshotAccessDenied", "ResourceSnapshotValidationFailed", "ResourceSnapshotConflict", - "InternalError", "ServiceQuotaExceeded", "RequestThrottled" ] @@ -4877,7 +4960,7 @@ }, "EngagementId":{ "shape":"EngagementIdentifier", - "documentation":"<p> The unique identifier for the engagement within the AWS Partner Central system. This ID is used for direct references to the engagement within the service. </p>" + "documentation":"<p>The unique identifier of the Engagement.</p>" }, "Id":{ "shape":"ResourceSnapshotJobIdentifier", @@ -4885,7 +4968,7 @@ }, "Status":{ "shape":"ResourceSnapshotJobStatus", - "documentation":"<p> Represents the current status of the resource snapshot job. </p>" + "documentation":"<p>The current status of the snapshot job.</p> <p>Valid values:</p> <ul> <li> <p> STOPPED: The job is not currently running. </p> </li> <li> <p> RUNNING: The job is actively executing. </p> </li> </ul>" } }, "documentation":"<p> An object that contains a <code>Resource Snapshot Job</code>'s subset of fields. </p>" @@ -4919,7 +5002,7 @@ }, "CreatedBy":{ "shape":"AwsAccount", - "documentation":"<p>The AWS account ID of the principal (user or role) who created the snapshot. This helps in tracking the origin of the snapshot. </p>" + "documentation":"<p>The AWS account ID of the entity that owns the resource from which the snapshot was created.</p>" }, "ResourceId":{ "shape":"ResourceIdentifier", @@ -4935,7 +5018,7 @@ }, "Revision":{ "shape":"ResourceSnapshotRevision", - "documentation":"<p> The revision number of the snapshot. This integer value is incremented each time the snapshot is updated, allowing for version tracking of the resource snapshot. </p>" + "documentation":"<p>The revision number of the snapshot. This integer value is incremented each time the snapshot is updated, allowing for version tracking of the resource snapshot. </p>" } }, "documentation":"<p> Provides a concise summary of a resource snapshot, including its unique identifier and version information. This structure is used to quickly reference and identify specific versions of resource snapshots. </p>" @@ -5216,6 +5299,10 @@ "Identifier":{ "shape":"EngagementInvitationArnOrIdentifier", "documentation":"<p>Specifies the unique identifier of the <code>EngagementInvitation</code> to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.</p>" + }, + "Tags":{ + "shape":"TagList", + "documentation":"<p>A list of objects specifying each tag name and value.</p>" } } }, @@ -5245,7 +5332,7 @@ }, "ResourceSnapshotJobId":{ "shape":"ResourceSnapshotJobIdentifier", - "documentation":"<p> The identifier of the resource snapshot job created as part of this task. </p>" + "documentation":"<p>The identifier of the Resource Snapshot Job created as part of this task.</p>" }, "StartTime":{ "shape":"DateTime", @@ -5287,6 +5374,10 @@ "Identifier":{ "shape":"OpportunityIdentifier", "documentation":"<p>The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.</p>" + }, + "Tags":{ + "shape":"TagList", + "documentation":"<p>A list of objects specifying each tag name and value.</p>" } } }, @@ -5300,11 +5391,11 @@ "members":{ "EngagementId":{ "shape":"EngagementIdentifier", - "documentation":"<p> The identifier of the newly created engagement. Only populated if TaskStatus is COMPLETE. </p>" + "documentation":"<p>The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.</p>" }, "EngagementInvitationId":{ "shape":"EngagementInvitationIdentifier", - "documentation":"<p> The identifier of the new engagement invitation. Only populated if TaskStatus is COMPLETE. </p>" + "documentation":"<p>The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.</p>" }, "Message":{ "shape":"String", @@ -5320,7 +5411,7 @@ }, "ResourceSnapshotJobId":{ "shape":"ResourceSnapshotJobIdentifier", - "documentation":"<p> The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE. </p>" + "documentation":"<p>The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE</p>" }, "StartTime":{ "shape":"DateTime", @@ -5349,11 +5440,11 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> Specifies the catalog related to the request. </p>" + "documentation":"<p>Specifies the catalog related to the request. Valid values are:</p> <ul> <li> <p>AWS: Starts the request from the production AWS environment.</p> </li> <li> <p>Sandbox: Starts the request from a sandbox environment used for testing or development purposes.</p> </li> </ul>" }, "ResourceSnapshotJobIdentifier":{ "shape":"ResourceSnapshotJobIdentifier", - "documentation":"<p> The identifier of the resource snapshot job to start. </p>" + "documentation":"<p>The identifier of the resource snapshot job to start.</p>" } } }, @@ -5366,11 +5457,11 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> Specifies the catalog related to the request. </p>" + "documentation":"<p>Specifies the catalog related to the request. Valid values are:</p> <ul> <li> <p>AWS: Stops the request from the production AWS environment.</p> </li> <li> <p>Sandbox: Stops the request from a sandbox environment used for testing or development purposes.</p> </li> </ul>" }, "ResourceSnapshotJobIdentifier":{ "shape":"ResourceSnapshotJobIdentifier", - "documentation":"<p> The identifier of the job to stop. </p>" + "documentation":"<p>The identifier of the job to stop.</p>" } } }, @@ -5385,22 +5476,92 @@ "members":{ "Catalog":{ "shape":"CatalogIdentifier", - "documentation":"<p> Specifies the catalog related to the request. </p>" + "documentation":"<p>Specifies the catalog related to the request. Valid values are:</p> <ul> <li> <p>AWS: Submits the opportunity request from the production AWS environment.</p> </li> <li> <p>Sandbox: Submits the opportunity request from a sandbox environment used for testing or development purposes.</p> </li> </ul>" }, "Identifier":{ "shape":"OpportunityIdentifier", - "documentation":"<p> The identifier of the opportunity previously created by partner and needs to be submitted. </p>" + "documentation":"<p>The identifier of the Opportunity previously created by partner and needs to be submitted.</p>" }, "InvolvementType":{ "shape":"SalesInvolvementType", - "documentation":"<p> Specifies the level of AWS sellers' involvement on the opportunity. </p>" + "documentation":"<p>Specifies the level of AWS sellers' involvement on the opportunity. Valid values:</p> <ul> <li> <p> <code>Co-sell</code>: Indicates the user wants to co-sell with AWS. Share the opportunity with AWS to receive deal assistance and support.</p> </li> <li> <p> <code>For Visibility Only</code>: Indicates that the user does not need support from AWS Sales Rep. Share this opportunity with AWS for visibility only, you will not receive deal assistance and support.</p> </li> </ul>" }, "Visibility":{ "shape":"Visibility", - "documentation":"<p> Determines whether to restrict visibility of the opportunity from AWS sales. Default value is Full. </p>" + "documentation":"<p>Determines whether to restrict visibility of the opportunity from AWS sales. Default value is Full. Valid values:</p> <ul> <li> <p> <code>Full</code>: The opportunity is fully visible to AWS sales.</p> </li> <li> <p> <code>Limited</code>: The opportunity has restricted visibility to AWS sales.</p> </li> </ul>" + } + } + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"<p>The key in the tag.</p>" + }, + "Value":{ + "shape":"TagValue", + "documentation":"<p>The value in the tag.</p>" + } + }, + "documentation":"<p>The key-value pair assigned to a specified resource.</p>" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"TaggableResourceArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to tag.</p>" + }, + "Tags":{ + "shape":"TagList", + "documentation":"<p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>" } } }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TaggableResourceArn":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^arn:[\\w+=/,.@-]+:partnercentral:[\\w+=/,.@-]*:[0-9]{12}:catalog/([a-zA-Z]+)/[\\w+=,.@-]+(/[\\w+=,.@-]+)*$" + }, "TaskArn":{ "type":"string", "pattern":"^arn:.*" @@ -5441,6 +5602,28 @@ "documentation":"<p>This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.</p> <p>This error occurs when there are too many requests sent. Review the provided <a href=\"https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html\">Quotas</a> and retry after the provided delay.</p>", "exception":true }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"TaggableResourceArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to untag.</p>" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"<p>The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.</p>" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, "UpdateOpportunityRequest":{ "type":"structure", "required":[ @@ -5487,7 +5670,7 @@ }, "PrimaryNeedsFromAws":{ "shape":"PrimaryNeedsFromAws", - "documentation":"<p>Identifies the type of support the partner needs from Amazon Web Services.</p> <p>Valid values:</p> <ul> <li> <p>Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.</p> </li> <li> <p>Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.</p> </li> <li> <p>Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.</p> </li> <li> <p>Cosell—Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).</p> </li> <li> <p>Cosell—Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.</p> </li> <li> <p>Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.</p> </li> <li> <p>Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).</p> </li> <li> <p>Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services.</p> </li> <li> <p>Do Not Need Support from AWS Sales Rep: Indicates that a partner doesn't need support from an Amazon Web Services Sales representative. The opportunity is managed solely by the partner. It's possible to request coselling support on these opportunities at any stage during their lifecycle. Also known as, for-visibility-only (FVO) opportunity.</p> </li> </ul>" + "documentation":"<p>Identifies the type of support the partner needs from Amazon Web Services.</p> <p>Valid values:</p> <ul> <li> <p>Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.</p> </li> <li> <p>Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.</p> </li> <li> <p>Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.</p> </li> <li> <p>Cosell—Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).</p> </li> <li> <p>Cosell—Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.</p> </li> <li> <p>Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.</p> </li> <li> <p>Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).</p> </li> <li> <p>Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services.</p> </li> </ul>" }, "Project":{ "shape":"Project", diff --git a/contrib/python/botocore/py3/botocore/data/pi/2018-02-27/service-2.json b/contrib/python/botocore/py3/botocore/data/pi/2018-02-27/service-2.json index 1b1ff81e339..f823cb0bb7f 100644 --- a/contrib/python/botocore/py3/botocore/data/pi/2018-02-27/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/pi/2018-02-27/service-2.json @@ -74,7 +74,7 @@ {"shape":"InternalServiceError"}, {"shape":"NotAuthorizedException"} ], - "documentation":"<p>Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code> associated with this ID. This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code> don't support retrieval of large SQL statement text.</p>" + "documentation":"<p>Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, <code>GetDimensionKeyDetails</code> retrieves the full text of the dimension <code>db.sql.statement</code> associated with this ID. This operation is useful because <code>GetResourceMetrics</code> and <code>DescribeDimensionKeys</code> don't support retrieval of large SQL statement text, lock snapshots, and execution plans.</p>" }, "GetPerformanceAnalysisReport":{ "name":"GetPerformanceAnalysisReport", @@ -479,7 +479,7 @@ }, "AdditionalMetrics":{ "shape":"AdditionalMetricsList", - "documentation":"<p>Additional metrics for the top <code>N</code> dimension keys. If the specified dimension group in the <code>GroupBy</code> parameter is <code>db.sql_tokenized</code>, you can specify per-SQL metrics to get the values for the top <code>N</code> SQL digests. The response syntax is as follows: <code>\"AdditionalMetrics\" : { \"<i>string</i>\" : \"<i>string</i>\" }</code>. </p>" + "documentation":"<p>Additional metrics for the top <code>N</code> dimension keys. If the specified dimension group in the <code>GroupBy</code> parameter is <code>db.sql_tokenized</code>, you can specify per-SQL metrics to get the values for the top <code>N</code> SQL digests. The response syntax is as follows: <code>\"AdditionalMetrics\" : { \"<i>string</i>\" : \"<i>string</i>\" }</code>.</p> <p>The only supported statistic function is <code>.avg</code>.</p>" }, "PartitionBy":{ "shape":"DimensionGroup", @@ -568,11 +568,11 @@ "members":{ "Group":{ "shape":"SanitizedString", - "documentation":"<p>The name of the dimension group. Valid values are as follows:</p> <ul> <li> <p> <code>db</code> - The name of the database to which the client is connected. The following values are permitted:</p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Aurora MySQL</p> </li> <li> <p>Amazon RDS MySQL</p> </li> <li> <p>Amazon RDS MariaDB</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.application</code> - The name of the application that is connected to the database. The following values are permitted:</p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.host</code> - The host name of the connected client (all engines).</p> </li> <li> <p> <code>db.query</code> - The query that is currently running (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query_tokenized</code> - The digest query (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).</p> </li> <li> <p> <code>db.sql</code> - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql_tokenized</code> - The SQL digest (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.user</code> - The user logged in to the database (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event</code> - The event for which the database backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_state</code> - The event for which the database backend is waiting (only Amazon DocumentDB).</p> </li> </ul>" + "documentation":"<p>The name of the dimension group. Valid values are as follows:</p> <ul> <li> <p> <code>db</code> - The name of the database to which the client is connected. The following values are permitted:</p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Aurora MySQL</p> </li> <li> <p>Amazon RDS MySQL</p> </li> <li> <p>Amazon RDS MariaDB</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.application</code> - The name of the application that is connected to the database. The following values are permitted:</p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.blocking_sql</code> - The SQL queries blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_session</code> - The sessions blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_object</code> - The object resources acquired by other sessions that are blocking the most DB load.</p> </li> <li> <p> <code>db.host</code> - The host name of the connected client (all engines).</p> </li> <li> <p> <code>db.plans</code> - The execution plans for the query (only Aurora PostgreSQL).</p> </li> <li> <p> <code>db.query</code> - The query that is currently running (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query_tokenized</code> - The digest query (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).</p> </li> <li> <p> <code>db.sql</code> - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql_tokenized</code> - The SQL digest (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.user</code> - The user logged in to the database (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event</code> - The event for which the database backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_state</code> - The event for which the database backend is waiting (only Amazon DocumentDB).</p> </li> </ul>" }, "Dimensions":{ "shape":"SanitizedStringList", - "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> <code>db.application.name</code> - The name of the application that is connected to the database. Valid values are as follows: </p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.host.id</code> - The host ID of the connected client (all engines).</p> </li> <li> <p> <code>db.host.name</code> - The host name of the connected client (all engines).</p> </li> <li> <p> <code>db.name</code> - The name of the database to which the client is connected. Valid values are as follows:</p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Aurora MySQL</p> </li> <li> <p>Amazon RDS MySQL</p> </li> <li> <p>Amazon RDS MariaDB</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.query.id</code> - The query ID generated by Performance Insights (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.db_id</code> - The query ID generated by the database (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.statement</code> - The text of the query that is being run (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.tokenized_id</code> </p> </li> <li> <p> <code>db.query.tokenized.id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.tokenized.db_id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.tokenized.statement</code> - The text of the query digest (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.session_type.name</code> - The type of the current session (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql.id</code> - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql.db_id</code> - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with <code>pi-</code> (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql.statement</code> - The full text of the SQL statement that is running, as in <code>SELECT * FROM employees</code> (all engines except Amazon DocumentDB)</p> </li> <li> <p> <code>db.sql.tokenized_id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The <code>db.sql.tokenized_id</code> dimension fetches the value of the <code>db.sql_tokenized.id</code> dimension. Amazon RDS returns <code>db.sql.tokenized_id</code> from the <code>db.sql</code> dimension group. </p> </li> <li> <p> <code>db.sql_tokenized.id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, <code>db.sql_tokenized.id</code> is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.</p> </li> <li> <p> <code>db.sql_tokenized.db_id</code> - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as <code>pi-2372568224</code> that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql_tokenized.statement</code> - The text of the SQL digest, as in <code>SELECT * FROM employees WHERE employee_id = ?</code> (all engines except Amazon DocumentDB)</p> </li> <li> <p> <code>db.user.id</code> - The ID of the user logged in to the database (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.user.name</code> - The name of the user logged in to the database (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_state.name</code> - The event for which the backend is waiting (only Amazon DocumentDB).</p> </li> </ul>" + "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> <code>db.application.name</code> - The name of the application that is connected to the database. Valid values are as follows: </p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.blocking_sql.id</code> - The ID for each of the SQL queries blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_sql.sql</code> - The SQL text for each of the SQL queries blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_session.id</code> - The ID for each of the sessions blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_object.id</code> - The ID for each of the object resources acquired by other sessions that are blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_object.type</code> - The object type for each of the object resources acquired by other sessions that are blocking the most DB load.</p> </li> <li> <p> <code>db.blocking_object.value</code> - The value for each of the object resources acquired by other sessions that are blocking the most DB load.</p> </li> <li> <p> <code>db.host.id</code> - The host ID of the connected client (all engines).</p> </li> <li> <p> <code>db.host.name</code> - The host name of the connected client (all engines).</p> </li> <li> <p> <code>db.name</code> - The name of the database to which the client is connected. Valid values are as follows:</p> <ul> <li> <p>Aurora PostgreSQL</p> </li> <li> <p>Amazon RDS PostgreSQL</p> </li> <li> <p>Aurora MySQL</p> </li> <li> <p>Amazon RDS MySQL</p> </li> <li> <p>Amazon RDS MariaDB</p> </li> <li> <p>Amazon DocumentDB</p> </li> </ul> </li> <li> <p> <code>db.query.id</code> - The query ID generated by Performance Insights (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.db_id</code> - The query ID generated by the database (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.statement</code> - The text of the query that is being run (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.tokenized_id</code> </p> </li> <li> <p> <code>db.query.tokenized.id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.tokenized.db_id</code> - The query digest ID generated by Performance Insights (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.query.tokenized.statement</code> - The text of the query digest (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.session_type.name</code> - The type of the current session (only Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql.id</code> - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql.db_id</code> - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with <code>pi-</code> (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql.statement</code> - The full text of the SQL statement that is running, as in <code>SELECT * FROM employees</code> (all engines except Amazon DocumentDB)</p> </li> <li> <p> <code>db.sql.tokenized_id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The <code>db.sql.tokenized_id</code> dimension fetches the value of the <code>db.sql_tokenized.id</code> dimension. Amazon RDS returns <code>db.sql.tokenized_id</code> from the <code>db.sql</code> dimension group. </p> </li> <li> <p> <code>db.sql_tokenized.id</code> - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, <code>db.sql_tokenized.id</code> is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.</p> </li> <li> <p> <code>db.sql_tokenized.db_id</code> - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as <code>pi-2372568224</code> that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.sql_tokenized.statement</code> - The text of the SQL digest, as in <code>SELECT * FROM employees WHERE employee_id = ?</code> (all engines except Amazon DocumentDB)</p> </li> <li> <p> <code>db.user.id</code> - The ID of the user logged in to the database (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.user.name</code> - The name of the user logged in to the database (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all engines except Amazon DocumentDB).</p> </li> <li> <p> <code>db.wait_state.name</code> - The event for which the backend is waiting (only Amazon DocumentDB).</p> </li> </ul>" }, "Limit":{ "shape":"Limit", @@ -713,15 +713,15 @@ }, "Group":{ "shape":"RequestString", - "documentation":"<p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:</p> <ul> <li> <p> <code>db.query</code> (Amazon DocumentDB only)</p> </li> <li> <p> <code>db.sql</code> (Amazon RDS and Aurora only)</p> </li> </ul>" + "documentation":"<p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:</p> <ul> <li> <p> <code>db.execution_plan</code> (Amazon RDS and Aurora only)</p> </li> <li> <p> <code>db.lock_snapshot</code> (Aurora only)</p> </li> <li> <p> <code>db.query</code> (Amazon DocumentDB only)</p> </li> <li> <p> <code>db.sql</code> (Amazon RDS and Aurora only)</p> </li> </ul>" }, "GroupIdentifier":{ "shape":"RequestString", - "documentation":"<p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is <code>db.sql.id</code>. The following group ID values are valid:</p> <ul> <li> <p> <code>db.sql.id</code> for dimension group <code>db.sql</code> (Aurora and RDS only)</p> </li> <li> <p> <code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p> </li> </ul>" + "documentation":"<p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is <code>db.sql.id</code>. The following group ID values are valid:</p> <ul> <li> <p> <code>db.execution_plan.id</code> for dimension group <code>db.execution_plan</code> (Aurora and RDS only)</p> </li> <li> <p> <code>db.sql.id</code> for dimension group <code>db.sql</code> (Aurora and RDS only)</p> </li> <li> <p> <code>db.query.id</code> for dimension group <code>db.query</code> (DocumentDB only)</p> </li> <li> <p>For the dimension group <code>db.lock_snapshot</code>, the <code>GroupIdentifier</code> is the epoch timestamp when Performance Insights captured the snapshot, in seconds. You can retrieve this value with the <code>GetResourceMetrics</code> operation for a 1 second period.</p> </li> </ul>" }, "RequestedDimensions":{ "shape":"RequestedDimensionList", - "documentation":"<p>A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:</p> <ul> <li> <p> <code>db.sql</code> - Specify either the full dimension name <code>db.sql.statement</code> or the short dimension name <code>statement</code> (Aurora and RDS only).</p> </li> <li> <p> <code>db.query</code> - Specify either the full dimension name <code>db.query.statement</code> or the short dimension name <code>statement</code> (DocumentDB only).</p> </li> </ul>" + "documentation":"<p>A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:</p> <ul> <li> <p> <code>db.execution_plan</code> - Specify the dimension name <code>db.execution_plan.raw_plan</code> or the short dimension name <code>raw_plan</code> (Amazon RDS and Aurora only)</p> </li> <li> <p> <code>db.lock_snapshot</code> - Specify the dimension name <code>db.lock_snapshot.lock_trees</code> or the short dimension name <code>lock_trees</code>. (Aurora only)</p> </li> <li> <p> <code>db.sql</code> - Specify either the full dimension name <code>db.sql.statement</code> or the short dimension name <code>statement</code> (Aurora and RDS only).</p> </li> <li> <p> <code>db.query</code> - Specify either the full dimension name <code>db.query.statement</code> or the short dimension name <code>statement</code> (DocumentDB only).</p> </li> </ul>" } } }, @@ -839,7 +839,7 @@ }, "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>" + "documentation":"<p>The maximum number of items to return in the response.</p>" }, "NextToken":{ "shape":"NextToken", @@ -1234,6 +1234,10 @@ "shape":"DescriptiveMap", "documentation":"<p>A dimension map that contains the dimensions for this partition.</p>" }, + "Filter":{ + "shape":"DescriptiveMap", + "documentation":"<p>The filter for the Performance Insights metric.</p>" + }, "Value":{ "shape":"Double", "documentation":"<p>The value of the metric. For example, <code>9</code> for <code>db.load.avg</code>.</p>" diff --git a/contrib/python/botocore/py3/botocore/data/polly/2016-06-10/service-2.json b/contrib/python/botocore/py3/botocore/data/polly/2016-06-10/service-2.json index 90b6686623d..16268b48dc4 100644 --- a/contrib/python/botocore/py3/botocore/data/polly/2016-06-10/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/polly/2016-06-10/service-2.json @@ -430,7 +430,8 @@ "nl-BE", "fr-BE", "cs-CZ", - "de-CH" + "de-CH", + "en-SG" ] }, "LanguageCodeList":{ @@ -1120,7 +1121,8 @@ "Gregory", "Burcu", "Jitka", - "Sabrina" + "Sabrina", + "Jasmine" ] }, "VoiceList":{ diff --git a/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/paginators-1.json b/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/paginators-1.json index 9c8e63b21a7..16c9a5f3d0f 100644 --- a/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/paginators-1.json @@ -107,6 +107,12 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "relevantContent" + }, + "ListSubscriptions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "subscriptions" } } } diff --git a/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/paginators-1.sdk-extras.json b/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/paginators-1.sdk-extras.json index 91d23c40efa..5bb16e2f6b4 100644 --- a/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/paginators-1.sdk-extras.json +++ b/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/paginators-1.sdk-extras.json @@ -6,9 +6,10 @@ "non_aggregate_keys": [ "responseScope", "blockedPhrases", - "creatorModeConfiguration" + "creatorModeConfiguration", + "orchestrationConfiguration" ] } } } -}
\ No newline at end of file +} diff --git a/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/service-2.json b/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/service-2.json index da91069559d..bb8972e24a3 100644 --- a/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/qbusiness/2023-11-27/service-2.json @@ -32,7 +32,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Adds or updates a permission policy for a Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Q Business application's resources.</p>" + "documentation":"<p>Adds or updates a permission policy for a Amazon Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Amazon Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Amazon Q Business application's resources.</p>" }, "BatchDeleteDocument":{ "name":"BatchDeleteDocument", @@ -73,6 +73,25 @@ ], "documentation":"<p>Adds one or more documents to an Amazon Q Business index.</p> <p>You use this API to:</p> <ul> <li> <p>ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.</p> </li> <li> <p>add custom attributes to documents in an Amazon Q Business index.</p> </li> <li> <p>attach an access control list to the documents added to an Amazon Q Business index.</p> </li> </ul> <p>You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.</p>" }, + "CancelSubscription":{ + "name":"CancelSubscription", + "http":{ + "method":"DELETE", + "requestUri":"/applications/{applicationId}/subscriptions/{subscriptionId}", + "responseCode":200 + }, + "input":{"shape":"CancelSubscriptionRequest"}, + "output":{"shape":"CancelSubscriptionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"<p>Unsubscribes a user or a group from their pricing tier in an Amazon Q Business application. An unsubscribed user or group loses all Amazon Q Business feature access at the start of next month. </p>", + "idempotent":true + }, "Chat":{ "name":"Chat", "http":{ @@ -154,7 +173,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Creates a new data accessor for an ISV to access data from a Q Business application. The data accessor is an entity that represents the ISV's access to the Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an AWS IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Q Business application.</p>", + "documentation":"<p>Creates a new data accessor for an ISV to access data from a Amazon Q Business application. The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.</p>", "idempotent":true }, "CreateDataSource":{ @@ -239,6 +258,26 @@ ], "documentation":"<p>Adds a retriever to your Amazon Q Business application.</p>" }, + "CreateSubscription":{ + "name":"CreateSubscription", + "http":{ + "method":"POST", + "requestUri":"/applications/{applicationId}/subscriptions", + "responseCode":200 + }, + "input":{"shape":"CreateSubscriptionRequest"}, + "output":{"shape":"CreateSubscriptionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"<p>Subscribes an IAM Identity Center user or a group to a pricing tier for an Amazon Q Business application.</p> <p>Amazon Q Business offers two subscription tiers: <code>Q_LITE</code> and <code>Q_BUSINESS</code>. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href=\"https://aws.amazon.com/q/business/pricing/\">Amazon Q Business pricing</a>.</p>", + "idempotent":true + }, "CreateUser":{ "name":"CreateUser", "http":{ @@ -356,7 +395,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Deletes a specified data accessor. This operation permanently removes the data accessor and its associated AWS IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked</p>", + "documentation":"<p>Deletes a specified data accessor. This operation permanently removes the data accessor and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.</p>", "idempotent":true }, "DeleteDataSource":{ @@ -516,7 +555,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Removes a permission policy from a Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.</p>", + "documentation":"<p>Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.</p>", "idempotent":true }, "GetApplication":{ @@ -553,7 +592,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Gets information about an chat controls configured for an existing Amazon Q Business application.</p>" + "documentation":"<p>Gets information about chat controls configured for an existing Amazon Q Business application.</p>" }, "GetDataAccessor":{ "name":"GetDataAccessor", @@ -571,7 +610,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Q Business application and AWS IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.</p>" + "documentation":"<p>Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.</p>" }, "GetDataSource":{ "name":"GetDataSource", @@ -682,7 +721,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Retrieves the current permission policy for a Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.</p>" + "documentation":"<p>Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.</p>" }, "GetRetriever":{ "name":"GetRetriever", @@ -810,7 +849,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Lists the data accessors for a Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.</p>" + "documentation":"<p>Lists the data accessors for a Amazon Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.</p>" }, "ListDataSourceSyncJobs":{ "name":"ListDataSourceSyncJobs", @@ -1011,6 +1050,25 @@ ], "documentation":"<p>Lists the retriever used by an Amazon Q Business application.</p>" }, + "ListSubscriptions":{ + "name":"ListSubscriptions", + "http":{ + "method":"GET", + "requestUri":"/applications/{applicationId}/subscriptions", + "responseCode":200 + }, + "input":{"shape":"ListSubscriptionsRequest"}, + "output":{"shape":"ListSubscriptionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"<p> Lists all subscriptions created in an Amazon Q Business application. </p>" + }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -1082,7 +1140,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Create, or updates, a mapping of users—who have access to a document—to groups.</p> <p>You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.</p>", + "documentation":"<p>Create, or updates, a mapping of users—who have access to a document—to groups.</p> <p>You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.</p> <p>There are two options for creating groups, either passing group members inline or using an S3 file via the S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both an S3 file and a <code>RoleArn</code> for Amazon Q Buisness to access the file.</p>", "idempotent":true }, "SearchRelevantContent":{ @@ -1102,7 +1160,7 @@ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], - "documentation":"<p>Searches for relevant content in a Q Business application based on a query. This operation takes a search query text, the Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.</p>" + "documentation":"<p>Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.</p>" }, "StartDataSourceSyncJob":{ "name":"StartDataSourceSyncJob", @@ -1220,7 +1278,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"<p>Updates an set of chat controls configured for an existing Amazon Q Business application.</p>", + "documentation":"<p>Updates a set of chat controls configured for an existing Amazon Q Business application.</p>", "idempotent":true }, "UpdateDataAccessor":{ @@ -1326,6 +1384,26 @@ "documentation":"<p>Updates the retriever used for your Amazon Q Business application.</p>", "idempotent":true }, + "UpdateSubscription":{ + "name":"UpdateSubscription", + "http":{ + "method":"PUT", + "requestUri":"/applications/{applicationId}/subscriptions/{subscriptionId}", + "responseCode":200 + }, + "input":{"shape":"UpdateSubscriptionRequest"}, + "output":{"shape":"UpdateSubscriptionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"<p>Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant. Downgrades apply at the start of the next month. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href=\"https://aws.amazon.com/q/business/pricing/\">Amazon Q Business pricing</a>.</p>", + "idempotent":true + }, "UpdateUser":{ "name":"UpdateUser", "http":{ @@ -1440,7 +1518,7 @@ "members":{ "action":{ "shape":"QIamAction", - "documentation":"<p>The Q Business action that is allowed.</p>" + "documentation":"<p>The Amazon Q Business action that is allowed.</p>" }, "filterConfiguration":{ "shape":"ActionFilterConfiguration", @@ -1796,6 +1874,17 @@ }, "documentation":"<p>The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html\">Admin controls and guardrails</a> and <a href=\"https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope\">Conversation settings</a>.</p>" }, + "AppliedOrchestrationConfiguration":{ + "type":"structure", + "required":["control"], + "members":{ + "control":{ + "shape":"OrchestrationControl", + "documentation":"<p> Information about whether chat orchestration is enabled or disabled for an Amazon Q Business application. </p>" + } + }, + "documentation":"<p>The chat orchestration specific admin controls configured for an Amazon Q Business application. Determines whether Amazon Q Business automatically routes chat requests across configured plugins and data sources in your Amazon Q Business application.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails-global-controls.html#guardrails-global-orchestration\">Chat orchestration settings</a>.</p>" + }, "AssociatePermissionRequest":{ "type":"structure", "required":[ @@ -1807,7 +1896,7 @@ "members":{ "applicationId":{ "shape":"ApplicationId", - "documentation":"<p>The unique identifier of the Q Business application.</p>", + "documentation":"<p>The unique identifier of the Amazon Q Business application.</p>", "location":"uri", "locationName":"applicationId" }, @@ -1817,11 +1906,11 @@ }, "actions":{ "shape":"QIamActions", - "documentation":"<p>The list of Q Business actions that the ISV is allowed to perform.</p>" + "documentation":"<p>The list of Amazon Q Business actions that the ISV is allowed to perform.</p>" }, "principal":{ "shape":"PrincipalRoleArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the IAM role for the ISV that is being granted permission.</p>" + "documentation":"<p>The Amazon Resource Name of the IAM role for the ISV that is being granted permission.</p>" } } }, @@ -2303,6 +2392,44 @@ "max":2, "min":0 }, + "CancelSubscriptionRequest":{ + "type":"structure", + "required":[ + "applicationId", + "subscriptionId" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"<p>The identifier of the Amazon Q Business application for which the subscription is being cancelled.</p>", + "location":"uri", + "locationName":"applicationId" + }, + "subscriptionId":{ + "shape":"SubscriptionId", + "documentation":"<p>The identifier of the Amazon Q Business subscription being cancelled.</p>", + "location":"uri", + "locationName":"subscriptionId" + } + } + }, + "CancelSubscriptionResponse":{ + "type":"structure", + "members":{ + "subscriptionArn":{ + "shape":"SubscriptionArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription being cancelled.</p>" + }, + "currentSubscription":{ + "shape":"SubscriptionDetails", + "documentation":"<p>The type of your current Amazon Q Business subscription.</p>" + }, + "nextSubscription":{ + "shape":"SubscriptionDetails", + "documentation":"<p>The type of the Amazon Q Business subscription for the next month.</p>" + } + } + }, "ChatInput":{ "type":"structure", "required":["applicationId"], @@ -2795,7 +2922,7 @@ "members":{ "applicationId":{ "shape":"ApplicationId", - "documentation":"<p>The unique identifier of the Q Business application.</p>", + "documentation":"<p>The unique identifier of the Amazon Q Business application.</p>", "location":"uri", "locationName":"applicationId" }, @@ -2836,7 +2963,7 @@ }, "idcApplicationArn":{ "shape":"IdcApplicationArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the AWS IAM Identity Center application created for this data accessor.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM Identity Center application created for this data accessor.</p>" }, "dataAccessorArn":{ "shape":"DataAccessorArn", @@ -3083,6 +3210,56 @@ } } }, + "CreateSubscriptionRequest":{ + "type":"structure", + "required":[ + "applicationId", + "principal", + "type" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"<p>The identifier of the Amazon Q Business application the subscription should be added to.</p>", + "location":"uri", + "locationName":"applicationId" + }, + "principal":{ + "shape":"SubscriptionPrincipal", + "documentation":"<p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>" + }, + "type":{ + "shape":"SubscriptionType", + "documentation":"<p>The type of Amazon Q Business subscription you want to create.</p>" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"<p>A token that you provide to identify the request to create a subscription for your Amazon Q Business application.</p>", + "idempotencyToken":true + } + } + }, + "CreateSubscriptionResponse":{ + "type":"structure", + "members":{ + "subscriptionId":{ + "shape":"SubscriptionId", + "documentation":"<p>The identifier of the Amazon Q Business subscription created.</p>" + }, + "subscriptionArn":{ + "shape":"SubscriptionArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription created.</p>" + }, + "currentSubscription":{ + "shape":"SubscriptionDetails", + "documentation":"<p>The type of your current Amazon Q Business subscription.</p>" + }, + "nextSubscription":{ + "shape":"SubscriptionDetails", + "documentation":"<p>The type of the Amazon Q Business subscription for the next month.</p>" + } + } + }, "CreateUserRequest":{ "type":"structure", "required":[ @@ -3278,7 +3455,7 @@ }, "idcApplicationArn":{ "shape":"IdcApplicationArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the associated AWS IAM Identity Center application.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the associated IAM Identity Center application.</p>" }, "principal":{ "shape":"PrincipalRoleArn", @@ -3584,7 +3761,7 @@ "members":{ "applicationId":{ "shape":"ApplicationId", - "documentation":"<p>The unique identifier of the Q Business application.</p>", + "documentation":"<p>The unique identifier of the Amazon Q Business application.</p>", "location":"uri", "locationName":"applicationId" }, @@ -3833,7 +4010,7 @@ "members":{ "applicationId":{ "shape":"ApplicationId", - "documentation":"<p>The unique identifier of the Q Business application.</p>", + "documentation":"<p>The unique identifier of the Amazon Q Business application.</p>", "location":"uri", "locationName":"applicationId" }, @@ -4432,6 +4609,10 @@ "shape":"ResponseScope", "documentation":"<p>The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.</p>" }, + "orchestrationConfiguration":{ + "shape":"AppliedOrchestrationConfiguration", + "documentation":"<p> The chat response orchestration settings for your application.</p> <note> <p>Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html\">Supported languages</a>.</p> </note>" + }, "blockedPhrases":{ "shape":"BlockedPhrasesConfiguration", "documentation":"<p>The phrases blocked from chat by your chat control configuration.</p>" @@ -4459,7 +4640,7 @@ "members":{ "applicationId":{ "shape":"ApplicationId", - "documentation":"<p>The unique identifier of the Q Business application.</p>", + "documentation":"<p>The unique identifier of the Amazon Q Business application.</p>", "location":"uri", "locationName":"applicationId" }, @@ -4488,11 +4669,11 @@ }, "applicationId":{ "shape":"ApplicationId", - "documentation":"<p>The unique identifier of the Q Business application associated with this data accessor.</p>" + "documentation":"<p>The unique identifier of the Amazon Q Business application associated with this data accessor.</p>" }, "idcApplicationArn":{ "shape":"IdcApplicationArn", - "documentation":"<p>The Amazon Resource Name (ARN) of the AWS IAM Identity Center application associated with this data accessor.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the IAM Identity Center application associated with this data accessor.</p>" }, "principal":{ "shape":"PrincipalRoleArn", @@ -4860,7 +5041,7 @@ "members":{ "applicationId":{ "shape":"ApplicationId", - "documentation":"<p>The unique identifier of the Q Business application.</p>", + "documentation":"<p>The unique identifier of the Amazon Q Business application.</p>", "location":"uri", "locationName":"applicationId" } @@ -5068,6 +5249,12 @@ } } }, + "GroupIdentifier":{ + "type":"string", + "max":47, + "min":1, + "pattern":"([0-9a-f]{10}-|)[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}" + }, "GroupMembers":{ "type":"structure", "members":{ @@ -5532,7 +5719,7 @@ "members":{ "applicationId":{ "shape":"ApplicationId", - "documentation":"<p>The unique identifier of the Q Business application.</p>", + "documentation":"<p>The unique identifier of the Amazon Q Business application.</p>", "location":"uri", "locationName":"applicationId" }, @@ -6071,6 +6258,43 @@ } } }, + "ListSubscriptionsRequest":{ + "type":"structure", + "required":["applicationId"], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"<p>The identifier of the Amazon Q Business application linked to the subscription.</p>", + "location":"uri", + "locationName":"applicationId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business subscriptions.</p>", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResultsIntegerForListSubscriptions", + "documentation":"<p>The maximum number of Amazon Q Business subscriptions to return.</p>", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListSubscriptionsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions.</p>" + }, + "subscriptions":{ + "shape":"Subscriptions", + "documentation":"<p>An array of summary information on the subscriptions configured for an Amazon Q Business application.</p>" + } + } + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceARN"], @@ -6239,6 +6463,12 @@ "max":50, "min":1 }, + "MaxResultsIntegerForListSubscriptions":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, "MaxResultsIntegerForListWebExperiencesRequest":{ "type":"integer", "box":true, @@ -6565,6 +6795,24 @@ }, "documentation":"<p>Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.</p>" }, + "OrchestrationConfiguration":{ + "type":"structure", + "required":["control"], + "members":{ + "control":{ + "shape":"OrchestrationControl", + "documentation":"<p> Status information about whether chat orchestration is activated or deactivated for your Amazon Q Business application.</p>" + } + }, + "documentation":"<p>Configuration information required to enable chat orchestration for your Amazon Q Business application.</p> <note> <p>Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html\">Supported languages</a>.</p> </note>" + }, + "OrchestrationControl":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "Origin":{ "type":"string", "max":256, @@ -6903,7 +7151,7 @@ "groupMembers":{"shape":"GroupMembers"}, "roleArn":{ "shape":"RoleArn", - "documentation":"<p>The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.</p>" } } }, @@ -7285,7 +7533,7 @@ "members":{ "applicationId":{ "shape":"ApplicationId", - "documentation":"<p>The unique identifier of the Q Business application to search.</p>", + "documentation":"<p>The unique identifier of the Amazon Q Business application to search.</p>", "location":"uri", "locationName":"applicationId" }, @@ -7558,6 +7806,68 @@ "type":"list", "member":{"shape":"SubnetId"} }, + "Subscription":{ + "type":"structure", + "members":{ + "subscriptionId":{ + "shape":"SubscriptionId", + "documentation":"<p>The identifier of the Amazon Q Business subscription to be updated.</p>" + }, + "subscriptionArn":{ + "shape":"SubscriptionArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.</p>" + }, + "principal":{ + "shape":"SubscriptionPrincipal", + "documentation":"<p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>" + }, + "currentSubscription":{ + "shape":"SubscriptionDetails", + "documentation":"<p>The type of your current Amazon Q Business subscription.</p>" + }, + "nextSubscription":{ + "shape":"SubscriptionDetails", + "documentation":"<p>The type of the Amazon Q Business subscription for the next month.</p>" + } + }, + "documentation":"<p>Information about an Amazon Q Business subscription.</p> <p>Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application.</p> <p>Amazon Q Business offers two subscription tiers: <code>Q_LITE</code> and <code>Q_BUSINESS</code>. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href=\"https://aws.amazon.com/q/business/pricing/\">Amazon Q Business pricing</a>.</p>" + }, + "SubscriptionArn":{ + "type":"string", + "max":1224, + "min":10, + "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" + }, + "SubscriptionDetails":{ + "type":"structure", + "members":{ + "type":{ + "shape":"SubscriptionType", + "documentation":"<p> The type of an Amazon Q Business subscription. </p>" + } + }, + "documentation":"<p> The details of an Amazon Q Business subscription. </p>" + }, + "SubscriptionId":{ + "type":"string", + "max":1224, + "min":0 + }, + "SubscriptionPrincipal":{ + "type":"structure", + "members":{ + "user":{ + "shape":"UserIdentifier", + "documentation":"<p>The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.</p>" + }, + "group":{ + "shape":"GroupIdentifier", + "documentation":"<p>The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>" + } + }, + "documentation":"<p>A user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>", + "union":true + }, "SubscriptionType":{ "type":"string", "enum":[ @@ -7565,6 +7875,10 @@ "Q_BUSINESS" ] }, + "Subscriptions":{ + "type":"list", + "member":{"shape":"Subscription"} + }, "SyncSchedule":{ "type":"string", "max":998, @@ -7883,6 +8197,10 @@ "shape":"ResponseScope", "documentation":"<p>The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.</p>" }, + "orchestrationConfiguration":{ + "shape":"OrchestrationConfiguration", + "documentation":"<p> The chat response orchestration settings for your application.</p>" + }, "blockedPhrasesConfigurationUpdate":{ "shape":"BlockedPhrasesConfigurationUpdate", "documentation":"<p>The phrases blocked from chat by your chat control configuration.</p>" @@ -7916,7 +8234,7 @@ "members":{ "applicationId":{ "shape":"ApplicationId", - "documentation":"<p>The unique identifier of the Q Business application.</p>", + "documentation":"<p>The unique identifier of the Amazon Q Business application.</p>", "location":"uri", "locationName":"applicationId" }, @@ -8120,6 +8438,49 @@ "members":{ } }, + "UpdateSubscriptionRequest":{ + "type":"structure", + "required":[ + "applicationId", + "subscriptionId", + "type" + ], + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"<p>The identifier of the Amazon Q Business application where the subscription update should take effect.</p>", + "location":"uri", + "locationName":"applicationId" + }, + "subscriptionId":{ + "shape":"SubscriptionId", + "documentation":"<p>The identifier of the Amazon Q Business subscription to be updated.</p>", + "location":"uri", + "locationName":"subscriptionId" + }, + "type":{ + "shape":"SubscriptionType", + "documentation":"<p>The type of the Amazon Q Business subscription to be updated.</p>" + } + } + }, + "UpdateSubscriptionResponse":{ + "type":"structure", + "members":{ + "subscriptionArn":{ + "shape":"SubscriptionArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.</p>" + }, + "currentSubscription":{ + "shape":"SubscriptionDetails", + "documentation":"<p>The type of your current Amazon Q Business subscription.</p>" + }, + "nextSubscription":{ + "shape":"SubscriptionDetails", + "documentation":"<p>The type of the Amazon Q Business subscription for the next month.</p>" + } + } + }, "UpdateUserRequest":{ "type":"structure", "required":[ @@ -8273,6 +8634,12 @@ "min":1, "pattern":"\\P{C}*" }, + "UserIdentifier":{ + "type":"string", + "max":47, + "min":1, + "pattern":"([0-9a-f]{10}-|)[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}" + }, "UserIds":{ "type":"list", "member":{"shape":"String"} diff --git a/contrib/python/botocore/py3/botocore/data/quicksight/2018-04-01/service-2.json b/contrib/python/botocore/py3/botocore/data/quicksight/2018-04-01/service-2.json index 2668fd01ea3..fe9f13996bc 100644 --- a/contrib/python/botocore/py3/botocore/data/quicksight/2018-04-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/quicksight/2018-04-01/service-2.json @@ -16920,6 +16920,13 @@ }, "documentation":"<p>The configuration of destination parameter values.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>" }, + "DigitGroupingStyle":{ + "type":"string", + "enum":[ + "DEFAULT", + "LAKHS" + ] + }, "DimensionField":{ "type":"structure", "members":{ @@ -25217,7 +25224,9 @@ "THOUSANDS", "MILLIONS", "BILLIONS", - "TRILLIONS" + "TRILLIONS", + "LAKHS", + "CRORES" ] }, "NumericAxisOptions":{ @@ -31878,7 +31887,7 @@ "TableFieldOptionList":{ "type":"list", "member":{"shape":"TableFieldOption"}, - "max":100 + "max":201 }, "TableFieldOptions":{ "type":"structure", @@ -32089,11 +32098,16 @@ "SCROLLED" ] }, + "TableUnaggregatedFieldList":{ + "type":"list", + "member":{"shape":"UnaggregatedField"}, + "max":201 + }, "TableUnaggregatedFieldWells":{ "type":"structure", "members":{ "Values":{ - "shape":"UnaggregatedFieldList", + "shape":"TableUnaggregatedFieldList", "documentation":"<p>The values field well for a pivot table. Values are unaggregated for an unaggregated table.</p>" } }, @@ -32846,6 +32860,10 @@ "Visibility":{ "shape":"Visibility", "documentation":"<p>Determines the visibility of the thousands separator.</p>" + }, + "GroupingStyle":{ + "shape":"DigitGroupingStyle", + "documentation":"<p>Determines the way numbers are styled to accommodate different readability standards. The <code>DEFAULT</code> value uses the standard international grouping system and groups numbers by the thousands. The <code>LAKHS</code> value uses the Indian numbering system and groups numbers by lakhs and crores.</p>" } }, "documentation":"<p>The options that determine the thousands separator configuration.</p>" diff --git a/contrib/python/botocore/py3/botocore/data/rds-data/2018-08-01/service-2.json b/contrib/python/botocore/py3/botocore/data/rds-data/2018-08-01/service-2.json index 6422aa2c5ab..38f24957d69 100644 --- a/contrib/python/botocore/py3/botocore/data/rds-data/2018-08-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/rds-data/2018-08-01/service-2.json @@ -30,6 +30,7 @@ {"shape":"DatabaseUnavailableException"}, {"shape":"TransactionNotFoundException"}, {"shape":"InvalidSecretException"}, + {"shape":"InvalidResourceStateException"}, {"shape":"ServiceUnavailableError"}, {"shape":"ForbiddenException"}, {"shape":"DatabaseNotFoundException"}, @@ -57,6 +58,7 @@ {"shape":"DatabaseUnavailableException"}, {"shape":"TransactionNotFoundException"}, {"shape":"InvalidSecretException"}, + {"shape":"InvalidResourceStateException"}, {"shape":"ServiceUnavailableError"}, {"shape":"ForbiddenException"}, {"shape":"DatabaseNotFoundException"}, @@ -83,6 +85,7 @@ {"shape":"DatabaseUnavailableException"}, {"shape":"TransactionNotFoundException"}, {"shape":"InvalidSecretException"}, + {"shape":"InvalidResourceStateException"}, {"shape":"ServiceUnavailableError"}, {"shape":"ForbiddenException"}, {"shape":"DatabaseNotFoundException"}, @@ -132,6 +135,7 @@ {"shape":"DatabaseUnavailableException"}, {"shape":"TransactionNotFoundException"}, {"shape":"InvalidSecretException"}, + {"shape":"InvalidResourceStateException"}, {"shape":"ServiceUnavailableError"}, {"shape":"ForbiddenException"}, {"shape":"DatabaseNotFoundException"}, @@ -159,6 +163,7 @@ {"shape":"DatabaseUnavailableException"}, {"shape":"TransactionNotFoundException"}, {"shape":"InvalidSecretException"}, + {"shape":"InvalidResourceStateException"}, {"shape":"ServiceUnavailableError"}, {"shape":"ForbiddenException"}, {"shape":"DatabaseNotFoundException"}, @@ -476,7 +481,7 @@ "members":{ "message":{"shape":"ErrorMessage"} }, - "documentation":"<p>A request was canceled because the Aurora Serverless v2 DB instance was in a paused state. The Data API request automatically causes the DB instance to begin resuming. Wait a few seconds and try again.</p>", + "documentation":"<p>A request was cancelled because the Aurora Serverless v2 DB instance was paused. The Data API request automatically resumes the DB instance. Wait a few seconds and try again.</p>", "error":{ "httpStatusCode":400, "senderFault":true @@ -714,6 +719,18 @@ "exception":true, "fault":true }, + "InvalidResourceStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"<p>The resource is in an invalid state.</p>", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "InvalidSecretException":{ "type":"structure", "members":{ diff --git a/contrib/python/botocore/py3/botocore/data/rds/2014-10-31/service-2.json b/contrib/python/botocore/py3/botocore/data/rds/2014-10-31/service-2.json index f9b93f2fae6..62fabd483fa 100644 --- a/contrib/python/botocore/py3/botocore/data/rds/2014-10-31/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/rds/2014-10-31/service-2.json @@ -479,7 +479,7 @@ {"shape":"DBParameterGroupQuotaExceededFault"}, {"shape":"DBParameterGroupAlreadyExistsFault"} ], - "documentation":"<p>Creates a new DB parameter group.</p> <p>A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <code>ModifyDBParameterGroup</code>. Once you've created a DB parameter group, you need to associate it with your DB instance using <code>ModifyDBInstance</code>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.</p> <p>This command doesn't apply to RDS Custom.</p> <important> <p>After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href=\"https://console.aws.amazon.com/rds/\">Amazon RDS console</a> or the <i>DescribeDBParameters</i> command to verify that your DB parameter group has been created or modified.</p> </important>" + "documentation":"<p>Creates a new DB parameter group.</p> <p>A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using <code>ModifyDBParameterGroup</code>. Once you've created a DB parameter group, you need to associate it with your DB instance using <code>ModifyDBInstance</code>. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.</p> <p>This command doesn't apply to RDS Custom.</p>" }, "CreateDBProxy":{ "name":"CreateDBProxy", @@ -2283,7 +2283,7 @@ {"shape":"InvalidIntegrationStateFault"}, {"shape":"IntegrationConflictOperationFault"} ], - "documentation":"<p>Modifies a zero-ETL integration with Amazon Redshift.</p> <note> <p>Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.</p> </note>" + "documentation":"<p>Modifies a zero-ETL integration with Amazon Redshift.</p>" }, "ModifyOptionGroup":{ "name":"ModifyOptionGroup", @@ -2965,7 +2965,7 @@ {"shape":"SnapshotQuotaExceededFault"}, {"shape":"InvalidDBClusterStateFault"} ], - "documentation":"<p>Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html\"> Stopping an Amazon RDS DB Instance Temporarily</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use <code>StopDBCluster</code> instead.</p> </note>" + "documentation":"<p>Stops an Amazon RDS DB instance temporarily. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. The instance restarts automatically after 7 days.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html\"> Stopping an Amazon RDS DB Instance Temporarily</a> in the <i>Amazon RDS User Guide.</i> </p> <note> <p>This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use <code>StopDBCluster</code> instead.</p> </note>" }, "StopDBInstanceAutomatedBackupsReplication":{ "name":"StopDBInstanceAutomatedBackupsReplication", @@ -4234,7 +4234,7 @@ }, "EnableCloudwatchLogsExports":{ "shape":"LogTypeList", - "documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs.</p> <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p> <p>The following values are valid for each DB engine:</p> <ul> <li> <p>Aurora MySQL - <code>audit | error | general | slowquery</code> </p> </li> <li> <p>Aurora PostgreSQL - <code>postgresql</code> </p> </li> <li> <p>RDS for MySQL - <code>error | general | slowquery</code> </p> </li> <li> <p>RDS for PostgreSQL - <code>postgresql | upgrade</code> </p> </li> </ul> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>" + "documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs.</p> <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p> <p>The following values are valid for each DB engine:</p> <ul> <li> <p>Aurora MySQL - <code>audit | error | general | instance | slowquery</code> </p> </li> <li> <p>Aurora PostgreSQL - <code>instance | postgresql</code> </p> </li> <li> <p>RDS for MySQL - <code>error | general | slowquery</code> </p> </li> <li> <p>RDS for PostgreSQL - <code>postgresql | upgrade</code> </p> </li> </ul> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>" }, "EngineMode":{ "shape":"String", @@ -4310,7 +4310,7 @@ }, "DatabaseInsightsMode":{ "shape":"DatabaseInsightsMode", - "documentation":"<p>The mode of Database Insights to enable for the DB cluster.</p> <p>If you set this value to <code>advanced</code>, you must also set the <code>PerformanceInsightsEnabled</code> parameter to <code>true</code> and the <code>PerformanceInsightsRetentionPeriod</code> parameter to 465.</p> <p>Valid for Cluster Type: Aurora DB clusters only</p>" + "documentation":"<p>The mode of Database Insights to enable for the DB cluster.</p> <p>If you set this value to <code>advanced</code>, you must also set the <code>PerformanceInsightsEnabled</code> parameter to <code>true</code> and the <code>PerformanceInsightsRetentionPeriod</code> parameter to 465.</p> <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>" }, "EnablePerformanceInsights":{ "shape":"BooleanOptional", @@ -4617,7 +4617,7 @@ }, "DatabaseInsightsMode":{ "shape":"DatabaseInsightsMode", - "documentation":"<p>The mode of Database Insights to enable for the DB instance.</p> <p>This setting only applies to Amazon Aurora DB instances.</p> <note> <p>Currently, this value is inherited from the DB cluster and can't be changed.</p> </note>" + "documentation":"<p>The mode of Database Insights to enable for the DB instance.</p> <note> <p>Aurora DB instances inherit this value from the DB cluster, so you can't change this value.</p> </note>" }, "EnablePerformanceInsights":{ "shape":"BooleanOptional", @@ -4665,7 +4665,7 @@ }, "StorageThroughput":{ "shape":"IntegerOptional", - "documentation":"<p>The storage throughput value for the DB instance.</p> <p>This setting applies only to the <code>gp3</code> storage type.</p> <p>This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>" + "documentation":"<p>The storage throughput value, in mebibyte per second (MiBps), for the DB instance.</p> <p>This setting applies only to the <code>gp3</code> storage type.</p> <p>This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.</p>" }, "ManageMasterUserPassword":{ "shape":"BooleanOptional", @@ -4785,7 +4785,7 @@ }, "DatabaseInsightsMode":{ "shape":"DatabaseInsightsMode", - "documentation":"<p>The mode of Database Insights to enable for the read replica.</p> <note> <p>Currently, this setting is not supported.</p> </note>" + "documentation":"<p>The mode of Database Insights to enable for the read replica.</p> <note> <p>This setting isn't supported.</p> </note>" }, "EnablePerformanceInsights":{ "shape":"BooleanOptional", @@ -5271,7 +5271,7 @@ "Tags":{"shape":"TagList"}, "DataFilter":{ "shape":"DataFilter", - "documentation":"<p>Data filtering options for the integration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.filtering.html\">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a>. </p> <p>Valid for: Integrations with Aurora MySQL source DB clusters only</p>" + "documentation":"<p>Data filtering options for the integration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/zero-etl.filtering.html\">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a> or <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/zero-etl.filtering.html\">Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift</a>. </p>" }, "Description":{ "shape":"IntegrationDescription", @@ -5452,7 +5452,7 @@ "members":{ "AllocatedStorage":{ "shape":"IntegerOptional", - "documentation":"<p>For all database engines except Amazon Aurora, <code>AllocatedStorage</code> specifies the allocated storage size in gibibytes (GiB). For Aurora, <code>AllocatedStorage</code> always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.</p>" + "documentation":"<p> <code>AllocatedStorage</code> specifies the allocated storage size in gibibytes (GiB). For Aurora, <code>AllocatedStorage</code> can vary because Aurora DB cluster storage size adjusts as needed.</p>" }, "AvailabilityZones":{ "shape":"AvailabilityZones", @@ -5596,7 +5596,7 @@ }, "CloneGroupId":{ "shape":"String", - "documentation":"<p>The ID of the clone group with which the DB cluster is associated.</p>" + "documentation":"<p>The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null. </p> <p>If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.</p> <p>For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster.</p>" }, "ClusterCreateTime":{ "shape":"TStamp", @@ -8808,7 +8808,7 @@ }, "DeleteAutomatedBackups":{ "shape":"BooleanOptional", - "documentation":"<p>Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.</p>" + "documentation":"<p>Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the Amazon Web Services Backup policy specifies a point-in-time restore rule.</p>" } }, "documentation":"<p/>" @@ -12335,7 +12335,7 @@ }, "CloudwatchLogsExportConfiguration":{ "shape":"CloudwatchLogsExportConfiguration", - "documentation":"<p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.</p> <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p> <p>The following values are valid for each DB engine:</p> <ul> <li> <p>Aurora MySQL - <code>audit | error | general | slowquery</code> </p> </li> <li> <p>Aurora PostgreSQL - <code>postgresql</code> </p> </li> <li> <p>RDS for MySQL - <code>error | general | slowquery</code> </p> </li> <li> <p>RDS for PostgreSQL - <code>postgresql | upgrade</code> </p> </li> </ul> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\"> Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>" + "documentation":"<p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.</p> <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p> <p>The following values are valid for each DB engine:</p> <ul> <li> <p>Aurora MySQL - <code>audit | error | general | instance | slowquery</code> </p> </li> <li> <p>Aurora PostgreSQL - <code>instance | postgresql</code> </p> </li> <li> <p>RDS for MySQL - <code>error | general | slowquery</code> </p> </li> <li> <p>RDS for PostgreSQL - <code>postgresql | upgrade</code> </p> </li> </ul> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\"> Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>" }, "EngineVersion":{ "shape":"String", @@ -12407,7 +12407,7 @@ }, "DatabaseInsightsMode":{ "shape":"DatabaseInsightsMode", - "documentation":"<p>Specifies the mode of Database Insights to enable for the DB cluster.</p> <p>If you change the value from <code>standard</code> to <code>advanced</code>, you must set the <code>PerformanceInsightsEnabled</code> parameter to <code>true</code> and the <code>PerformanceInsightsRetentionPeriod</code> parameter to 465.</p> <p>If you change the value from <code>advanced</code> to <code>standard</code>, you must set the <code>PerformanceInsightsEnabled</code> parameter to <code>false</code>.</p> <p>Valid for Cluster Type: Aurora DB clusters only</p>" + "documentation":"<p>Specifies the mode of Database Insights to enable for the DB cluster.</p> <p>If you change the value from <code>standard</code> to <code>advanced</code>, you must set the <code>PerformanceInsightsEnabled</code> parameter to <code>true</code> and the <code>PerformanceInsightsRetentionPeriod</code> parameter to 465.</p> <p>If you change the value from <code>advanced</code> to <code>standard</code>, you must set the <code>PerformanceInsightsEnabled</code> parameter to <code>false</code>.</p> <p>Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters</p>" }, "EnablePerformanceInsights":{ "shape":"BooleanOptional", @@ -12679,7 +12679,7 @@ }, "DatabaseInsightsMode":{ "shape":"DatabaseInsightsMode", - "documentation":"<p>Specifies the mode of Database Insights to enable for the DB instance.</p> <p>This setting only applies to Amazon Aurora DB instances.</p> <note> <p>Currently, this value is inherited from the DB cluster and can't be changed.</p> </note>" + "documentation":"<p>Specifies the mode of Database Insights to enable for the DB instance.</p> <note> <p>Aurora DB instances inherit this value from the DB cluster, so you can't change this value.</p> </note>" }, "EnablePerformanceInsights":{ "shape":"BooleanOptional", @@ -12891,7 +12891,7 @@ }, "NewName":{ "shape":"String", - "documentation":"<p>The new name for the modified <code>DBProxyTarget</code>. 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>" + "documentation":"<p>The new name for the modified <code>DBProxyTarget</code>. 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>You can't rename the <code>default</code> target group.</p>" } } }, @@ -13110,7 +13110,7 @@ }, "DataFilter":{ "shape":"DataFilter", - "documentation":"<p>A new data filter for the integration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html\">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a>.</p>" + "documentation":"<p>A new data filter for the integration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Zero_ETL_Filtering.html\">Data filtering for Aurora zero-ETL integrations with Amazon Redshift</a> or <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/zero-etl.filtering.html\">Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift</a>.</p>" }, "Description":{ "shape":"IntegrationDescription", @@ -14971,7 +14971,7 @@ }, "EnableCloudwatchLogsExports":{ "shape":"LogTypeList", - "documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>" + "documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, <code>instance</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value are <code>instance</code> and <code>postgresql</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p>" }, "DeletionProtection":{ "shape":"BooleanOptional", @@ -15084,7 +15084,7 @@ }, "EnableCloudwatchLogsExports":{ "shape":"LogTypeList", - "documentation":"<p>The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p> <b>RDS for MySQL</b> </p> <p>Possible values are <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>RDS for PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value is <code>postgresql</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>" + "documentation":"<p>The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p> <b>RDS for MySQL</b> </p> <p>Possible values are <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>RDS for PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, <code>instance</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value are <code>instance</code> and <code>postgresql</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>" }, "EngineMode":{ "shape":"String", @@ -15227,7 +15227,7 @@ }, "EnableCloudwatchLogsExports":{ "shape":"LogTypeList", - "documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p> <b>RDS for MySQL</b> </p> <p>Possible values are <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>RDS for PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value is <code>postgresql</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>" + "documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.</p> <p> <b>RDS for MySQL</b> </p> <p>Possible values are <code>error</code>, <code>general</code>, and <code>slowquery</code>.</p> <p> <b>RDS for PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, <code>instance</code>, and <code>slowquery</code>.</p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value are <code>instance</code> and <code>postgresql</code>.</p> <p>For more information about exporting CloudWatch Logs for Amazon RDS, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about exporting CloudWatch Logs for Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>" }, "DBClusterParameterGroupName":{ "shape":"String", @@ -15655,7 +15655,7 @@ }, "DatabaseInsightsMode":{ "shape":"DatabaseInsightsMode", - "documentation":"<p>Specifies the mode of Database Insights to enable for the DB instance.</p> <p>This setting only applies to Amazon Aurora DB instances.</p> <note> <p>Currently, this value is inherited from the DB cluster and can't be changed.</p> </note>" + "documentation":"<p>Specifies the mode of Database Insights to enable for the DB instance.</p> <note> <p>Aurora DB instances inherit this value from the DB cluster, so you can't change this value.</p> </note>" }, "EnablePerformanceInsights":{ "shape":"BooleanOptional", diff --git a/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/paginators-1.sdk-extras.json b/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/paginators-1.sdk-extras.json index 262275b6be6..39e13606ef5 100644 --- a/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/paginators-1.sdk-extras.json +++ b/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/paginators-1.sdk-extras.json @@ -37,7 +37,8 @@ "ChecksumAlgorithm", "Initiator", "Owner", - "StorageClass" + "StorageClass", + "ChecksumType" ] } } diff --git a/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/service-2.json b/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/service-2.json index c3351524bac..4cd732442d0 100644 --- a/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/s3/2006-03-01/service-2.json @@ -28,7 +28,7 @@ {"shape":"NoSuchUpload"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html", - "documentation":"<p>This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts. </p> <p>To verify that all parts have been removed and prevent getting charged for the part storage, you should call the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> API operation and ensure that the parts list is empty.</p> <note> <ul> <li> <p> <b>Directory buckets</b> - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed. To delete these in-progress multipart uploads, use the <code>ListMultipartUploads</code> operation to list the in-progress multipart uploads in the bucket and use the <code>AbortMultipartUpload</code> operation to abort all the in-progress multipart uploads. </p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - For information about permissions required to use the multipart upload, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>AbortMultipartUpload</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>" + "documentation":"<p>This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts. </p> <p>To verify that all parts have been removed and prevent getting charged for the part storage, you should call the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> API operation and ensure that the parts list is empty.</p> <note> <ul> <li> <p> <b>Directory buckets</b> - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed. To delete these in-progress multipart uploads, use the <code>ListMultipartUploads</code> operation to list the in-progress multipart uploads in the bucket and use the <code>AbortMultipartUpload</code> operation to abort all the in-progress multipart uploads. </p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - For information about permissions required to use the multipart upload, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>AbortMultipartUpload</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>" }, "CompleteMultipartUpload":{ "name":"CompleteMultipartUpload", @@ -39,7 +39,7 @@ "input":{"shape":"CompleteMultipartUploadRequest"}, "output":{"shape":"CompleteMultipartUploadOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html", - "documentation":"<p>Completes a multipart upload by assembling previously uploaded parts.</p> <p>You first initiate the multipart upload and then upload all parts using the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> operation or the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a> operation. After successfully uploading all relevant parts of an upload, you call this <code>CompleteMultipartUpload</code> operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the CompleteMultipartUpload request, you must provide the parts list and ensure that the parts list is complete. The CompleteMultipartUpload API operation concatenates the parts that you provide in the list. For each part in the list, you must provide the <code>PartNumber</code> value and the <code>ETag</code> value that are returned after that part was uploaded.</p> <p>The processing of a CompleteMultipartUpload request could take several minutes to finalize. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a <code>200 OK</code> response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. A request could fail after the initial <code>200 OK</code> response has been sent. This means that a <code>200 OK</code> response can contain either a success or an error. The error response might be embedded in the <code>200 OK</code> response. If you call this API operation directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an error). </p> <p>Note that if <code>CompleteMultipartUpload</code> fails, applications should be prepared to retry any failed requests (including 500 error responses). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html\">Amazon S3 Error Best Practices</a>.</p> <important> <p>You can't use <code>Content-Type: application/x-www-form-urlencoded</code> for the CompleteMultipartUpload requests. Also, if you don't provide a <code>Content-Type</code> header, <code>CompleteMultipartUpload</code> can still return a <code>200 OK</code> response.</p> </important> <p>For more information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html\">additional checksum value</a> in your <code>MultipartUpload</code> requests and the object is encrypted with Key Management Service, you must have permission to use the <code>kms:Decrypt</code> action for the <code>CompleteMultipartUpload</code> request to succeed.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> </li> </ul> </dd> <dt>Special errors</dt> <dd> <ul> <li> <p>Error Code: <code>EntityTooSmall</code> </p> <ul> <li> <p>Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.</p> </li> <li> <p>HTTP Status Code: 400 Bad Request</p> </li> </ul> </li> <li> <p>Error Code: <code>InvalidPart</code> </p> <ul> <li> <p>Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified ETag might not have matched the uploaded part's ETag.</p> </li> <li> <p>HTTP Status Code: 400 Bad Request</p> </li> </ul> </li> <li> <p>Error Code: <code>InvalidPartOrder</code> </p> <ul> <li> <p>Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.</p> </li> <li> <p>HTTP Status Code: 400 Bad Request</p> </li> </ul> </li> <li> <p>Error Code: <code>NoSuchUpload</code> </p> <ul> <li> <p>Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> </ul> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>CompleteMultipartUpload</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>" + "documentation":"<p>Completes a multipart upload by assembling previously uploaded parts.</p> <p>You first initiate the multipart upload and then upload all parts using the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> operation or the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a> operation. After successfully uploading all relevant parts of an upload, you call this <code>CompleteMultipartUpload</code> operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the CompleteMultipartUpload request, you must provide the parts list and ensure that the parts list is complete. The CompleteMultipartUpload API operation concatenates the parts that you provide in the list. For each part in the list, you must provide the <code>PartNumber</code> value and the <code>ETag</code> value that are returned after that part was uploaded.</p> <p>The processing of a CompleteMultipartUpload request could take several minutes to finalize. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a <code>200 OK</code> response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. A request could fail after the initial <code>200 OK</code> response has been sent. This means that a <code>200 OK</code> response can contain either a success or an error. The error response might be embedded in the <code>200 OK</code> response. If you call this API operation directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an error). </p> <p>Note that if <code>CompleteMultipartUpload</code> fails, applications should be prepared to retry any failed requests (including 500 error responses). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html\">Amazon S3 Error Best Practices</a>.</p> <important> <p>You can't use <code>Content-Type: application/x-www-form-urlencoded</code> for the CompleteMultipartUpload requests. Also, if you don't provide a <code>Content-Type</code> header, <code>CompleteMultipartUpload</code> can still return a <code>200 OK</code> response.</p> </important> <p>For more information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html\">additional checksum value</a> in your <code>MultipartUpload</code> requests and the object is encrypted with Key Management Service, you must have permission to use the <code>kms:Decrypt</code> action for the <code>CompleteMultipartUpload</code> request to succeed.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> </li> </ul> </dd> <dt>Special errors</dt> <dd> <ul> <li> <p>Error Code: <code>EntityTooSmall</code> </p> <ul> <li> <p>Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.</p> </li> <li> <p>HTTP Status Code: 400 Bad Request</p> </li> </ul> </li> <li> <p>Error Code: <code>InvalidPart</code> </p> <ul> <li> <p>Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified ETag might not have matched the uploaded part's ETag.</p> </li> <li> <p>HTTP Status Code: 400 Bad Request</p> </li> </ul> </li> <li> <p>Error Code: <code>InvalidPartOrder</code> </p> <ul> <li> <p>Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.</p> </li> <li> <p>HTTP Status Code: 400 Bad Request</p> </li> </ul> </li> <li> <p>Error Code: <code>NoSuchUpload</code> </p> <ul> <li> <p>Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> </ul> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>CompleteMultipartUpload</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>" }, "CopyObject":{ "name":"CopyObject", @@ -53,7 +53,7 @@ {"shape":"ObjectNotInActiveTierError"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html", - "documentation":"<p>Creates a copy of an object that is already stored in Amazon S3.</p> <note> <p>You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html\">Copy Object Using the REST Multipart Upload API</a>.</p> </note> <p>You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.</p> <note> <ul> <li> <p>Amazon S3 supports copy operations using Multi-Region Access Points only as a destination when using the Multi-Region Access Point ARN. </p> </li> <li> <p> <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>VPC endpoints don't support cross-Region requests (including copies). If you're using VPC endpoints, your source and destination buckets should be in the same Amazon Web Services Region as your VPC endpoint.</p> </li> </ul> </note> <p>Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. For more information about how to enable a Region for your account, see <a href=\"https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone\">Enable or disable a Region for standalone accounts</a> in the <i>Amazon Web Services Account Management Guide</i>.</p> <important> <p>Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a <code>400 Bad Request</code> error. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html\">Transfer Acceleration</a>.</p> </important> <dl> <dt>Authentication and authorization</dt> <dd> <p>All <code>CopyObject</code> requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a>.</p> <p> <b>Directory buckets</b> - You must use the IAM credentials to authenticate and authorize your access to the <code>CopyObject</code> API operation, instead of using the temporary security credentials through the <code>CreateSession</code> API operation.</p> <p>Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.</p> </dd> <dt>Permissions</dt> <dd> <p>You must have <i>read</i> access to the source object and <i>write</i> access to the destination bucket.</p> <ul> <li> <p> <b>General purpose bucket permissions</b> - You must have permissions in an IAM policy based on the source and destination bucket types in a <code>CopyObject</code> operation.</p> <ul> <li> <p>If the source object is in a general purpose bucket, you must have <b> <code>s3:GetObject</code> </b> permission to read the source object that is being copied. </p> </li> <li> <p>If the destination bucket is a general purpose bucket, you must have <b> <code>s3:PutObject</code> </b> permission to write the object copy to the destination bucket. </p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in a <code>CopyObject</code> operation.</p> <ul> <li> <p>If the source object that you want to copy is in a directory bucket, you must have the <b> <code>s3express:CreateSession</code> </b> permission in the <code>Action</code> element of a policy to read the object. By default, the session is in the <code>ReadWrite</code> mode. If you want to restrict the access, you can explicitly set the <code>s3express:SessionMode</code> condition key to <code>ReadOnly</code> on the copy source bucket.</p> </li> <li> <p>If the copy destination is a directory bucket, you must have the <b> <code>s3express:CreateSession</code> </b> permission in the <code>Action</code> element of a policy to write the object to the destination. The <code>s3express:SessionMode</code> condition key can't be set to <code>ReadOnly</code> on the copy destination bucket. </p> </li> </ul> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> <p>For example policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html\">Example bucket policies for S3 Express One Zone</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html\">Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </dd> <dt>Response and special errors</dt> <dd> <p>When the request is an HTTP 1.1 request, the response is chunk encoded. When the request is not an HTTP 1.1 request, the response would not contain the <code>Content-Length</code>. You always need to read the entire response body to check if the copy succeeds. </p> <ul> <li> <p>If the copy is successful, you receive a response with information about the copied object.</p> </li> <li> <p>A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. A <code>200 OK</code> response can contain either a success or an error.</p> <ul> <li> <p>If the error occurs before the copy action starts, you receive a standard Amazon S3 error.</p> </li> <li> <p>If the error occurs during the copy operation, the error response is embedded in the <code>200 OK</code> response. For example, in a cross-region copy, you may encounter throttling and receive a <code>200 OK</code> response. For more information, see <a href=\"https://repost.aws/knowledge-center/s3-resolve-200-internalerror\">Resolve the Error 200 response when copying objects to Amazon S3</a>. The <code>200 OK</code> status code means the copy was accepted, but it doesn't mean the copy is complete. Another example is when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a <code>200 OK</code> response. You must stay connected to Amazon S3 until the entire response is successfully received and processed.</p> <p>If you call this API operation directly, make sure to design your application to parse the content of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an error).</p> </li> </ul> </li> </ul> </dd> <dt>Charge</dt> <dd> <p>The copy request charge is based on the storage class and Region that you specify for the destination object. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. If the copy source is in a different region, the data transfer is billed to the copy source account. For pricing information, see <a href=\"http://aws.amazon.com/s3/pricing/\">Amazon S3 pricing</a>.</p> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>CopyObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> </ul>", + "documentation":"<p>Creates a copy of an object that is already stored in Amazon S3.</p> <note> <p>You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html\">Copy Object Using the REST Multipart Upload API</a>.</p> </note> <p>You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.</p> <note> <ul> <li> <p>Amazon S3 supports copy operations using Multi-Region Access Points only as a destination when using the Multi-Region Access Point ARN. </p> </li> <li> <p> <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>VPC endpoints don't support cross-Region requests (including copies). If you're using VPC endpoints, your source and destination buckets should be in the same Amazon Web Services Region as your VPC endpoint.</p> </li> </ul> </note> <p>Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. For more information about how to enable a Region for your account, see <a href=\"https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone\">Enable or disable a Region for standalone accounts</a> in the <i>Amazon Web Services Account Management Guide</i>.</p> <important> <p>Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a <code>400 Bad Request</code> error. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html\">Transfer Acceleration</a>.</p> </important> <dl> <dt>Authentication and authorization</dt> <dd> <p>All <code>CopyObject</code> requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a>.</p> <p> <b>Directory buckets</b> - You must use the IAM credentials to authenticate and authorize your access to the <code>CopyObject</code> API operation, instead of using the temporary security credentials through the <code>CreateSession</code> API operation.</p> <p>Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.</p> </dd> <dt>Permissions</dt> <dd> <p>You must have <i>read</i> access to the source object and <i>write</i> access to the destination bucket.</p> <ul> <li> <p> <b>General purpose bucket permissions</b> - You must have permissions in an IAM policy based on the source and destination bucket types in a <code>CopyObject</code> operation.</p> <ul> <li> <p>If the source object is in a general purpose bucket, you must have <b> <code>s3:GetObject</code> </b> permission to read the source object that is being copied. </p> </li> <li> <p>If the destination bucket is a general purpose bucket, you must have <b> <code>s3:PutObject</code> </b> permission to write the object copy to the destination bucket. </p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in a <code>CopyObject</code> operation.</p> <ul> <li> <p>If the source object that you want to copy is in a directory bucket, you must have the <b> <code>s3express:CreateSession</code> </b> permission in the <code>Action</code> element of a policy to read the object. By default, the session is in the <code>ReadWrite</code> mode. If you want to restrict the access, you can explicitly set the <code>s3express:SessionMode</code> condition key to <code>ReadOnly</code> on the copy source bucket.</p> </li> <li> <p>If the copy destination is a directory bucket, you must have the <b> <code>s3express:CreateSession</code> </b> permission in the <code>Action</code> element of a policy to write the object to the destination. The <code>s3express:SessionMode</code> condition key can't be set to <code>ReadOnly</code> on the copy destination bucket. </p> </li> </ul> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> <p>For example policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html\">Example bucket policies for S3 Express One Zone</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html\">Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </dd> <dt>Response and special errors</dt> <dd> <p>When the request is an HTTP 1.1 request, the response is chunk encoded. When the request is not an HTTP 1.1 request, the response would not contain the <code>Content-Length</code>. You always need to read the entire response body to check if the copy succeeds. </p> <ul> <li> <p>If the copy is successful, you receive a response with information about the copied object.</p> </li> <li> <p>A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. A <code>200 OK</code> response can contain either a success or an error.</p> <ul> <li> <p>If the error occurs before the copy action starts, you receive a standard Amazon S3 error.</p> </li> <li> <p>If the error occurs during the copy operation, the error response is embedded in the <code>200 OK</code> response. For example, in a cross-region copy, you may encounter throttling and receive a <code>200 OK</code> response. For more information, see <a href=\"https://repost.aws/knowledge-center/s3-resolve-200-internalerror\">Resolve the Error 200 response when copying objects to Amazon S3</a>. The <code>200 OK</code> status code means the copy was accepted, but it doesn't mean the copy is complete. Another example is when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a <code>200 OK</code> response. You must stay connected to Amazon S3 until the entire response is successfully received and processed.</p> <p>If you call this API operation directly, make sure to design your application to parse the content of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an error).</p> </li> </ul> </li> </ul> </dd> <dt>Charge</dt> <dd> <p>The copy request charge is based on the storage class and Region that you specify for the destination object. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. If the copy source is in a different region, the data transfer is billed to the copy source account. For pricing information, see <a href=\"http://aws.amazon.com/s3/pricing/\">Amazon S3 pricing</a>.</p> </dd> <dt>HTTP Host header syntax</dt> <dd> <ul> <li> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </li> <li> <p> <b>Amazon S3 on Outposts</b> - When you use this action with S3 on Outposts through the REST API, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. The hostname isn't required when you use the Amazon Web Services CLI or SDKs.</p> </li> </ul> </dd> </dl> <p>The following operations are related to <code>CopyObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> </ul>", "alias":"PutObjectCopy", "staticContextParams":{ "DisableS3ExpressSessionAuth":{"value":true} @@ -104,7 +104,7 @@ "input":{"shape":"CreateMultipartUploadRequest"}, "output":{"shape":"CreateMultipartUploadOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html", - "documentation":"<p>This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a>). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html\">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stops charging you for storing them only after you either complete or abort a multipart upload. </p> </note> <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart upload must be completed within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config\">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a>.</p> <note> <ul> <li> <p> <b>Directory buckets </b> - S3 Lifecycle is not supported by directory buckets.</p> </li> <li> <p> <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <dl> <dt>Request signing</dt> <dd> <p>For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the <i>Amazon S3 User Guide</i>.</p> </dd> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - To perform a multipart upload with encryption using an Key Management Service (KMS) KMS key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey</code> actions on the key. The requester must also have permissions for the <code>kms:GenerateDataKey</code> action for the <code>CreateMultipartUpload</code> API. Then, the requester needs permissions for the <code>kms:Decrypt</code> action on the <code>UploadPart</code> and <code>UploadPartCopy</code> APIs. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions\">Multipart upload API and permissions</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html\">Protecting data using server-side encryption with Amazon Web Services KMS</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>Encryption</dt> <dd> <ul> <li> <p> <b>General purpose buckets</b> - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. Amazon S3 automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a multipart upload, if you don't specify encryption information in your request, the encryption setting of the uploaded parts is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use a different type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the object with a different encryption key (such as an Amazon S3 managed key, a KMS key, or a customer-provided key). When the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. If you choose to provide your own encryption key, the request headers you provide in <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a> requests must match the headers you used in the <code>CreateMultipartUpload</code> request.</p> <ul> <li> <p>Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (<code>aws/s3</code>) and KMS customer managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.</p> <ul> <li> <p> <code>x-amz-server-side-encryption</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-aws-kms-key-id</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-context</code> </p> </li> </ul> <note> <ul> <li> <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code> key) in KMS to protect the data.</p> </li> <li> <p>To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey*</code> actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions\">Multipart upload API and permissions</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html\">Protecting data using server-side encryption with Amazon Web Services KMS</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role is in a different account from the key, then you must have the permissions on both the key policy and your IAM user or role.</p> </li> <li> <p>All <code>GET</code> and <code>PUT</code> requests for an object protected by KMS fail if you don't make them by using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version\">Specifying the Signature Version in Request Authentication</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <p>For more information about server-side encryption with KMS keys (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with KMS keys</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption keys, provide all the following headers in the request.</p> <ul> <li> <p> <code>x-amz-server-side-encryption-customer-algorithm</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key-MD5</code> </p> </li> </ul> <p>For more information about server-side encryption with customer-provided encryption keys (SSE-C), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html\"> Protecting data using server-side encryption with customer-provided encryption keys (SSE-C)</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html\">Specifying server-side encryption with KMS for new object uploads</a>.</p> <p>In the Zonal endpoint API calls (except <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a>) using the REST API, the encryption request headers must match the encryption settings that are specified in the <code>CreateSession</code> request. You can't override the values of the encryption settings (<code>x-amz-server-side-encryption</code>, <code>x-amz-server-side-encryption-aws-kms-key-id</code>, <code>x-amz-server-side-encryption-context</code>, and <code>x-amz-server-side-encryption-bucket-key-enabled</code>) that are specified in the <code>CreateSession</code> request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the <code>CreateSession</code> request to protect new objects in the directory bucket. </p> <note> <p>When you use the CLI or the Amazon Web Services SDKs, for <code>CreateSession</code>, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the <code>CreateSession</code> request. It's not supported to override the encryption settings values in the <code>CreateSession</code> request. So in the Zonal endpoint API calls (except <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a>), the encryption request headers must match the default encryption configuration of the directory bucket. </p> </note> <note> <p>For directory buckets, when you perform a <code>CreateMultipartUpload</code> operation and an <code>UploadPartCopy</code> operation, the request headers you provide in the <code>CreateMultipartUpload</code> request must match the default encryption configuration of the destination bucket. </p> </note> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>CreateMultipartUpload</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>", + "documentation":"<p>This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a>). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html\">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stops charging you for storing them only after you either complete or abort a multipart upload. </p> </note> <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart upload must be completed within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config\">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a>.</p> <note> <ul> <li> <p> <b>Directory buckets </b> - S3 Lifecycle is not supported by directory buckets.</p> </li> <li> <p> <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <dl> <dt>Request signing</dt> <dd> <p>For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the <i>Amazon S3 User Guide</i>.</p> </dd> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - To perform a multipart upload with encryption using an Key Management Service (KMS) KMS key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey</code> actions on the key. The requester must also have permissions for the <code>kms:GenerateDataKey</code> action for the <code>CreateMultipartUpload</code> API. Then, the requester needs permissions for the <code>kms:Decrypt</code> action on the <code>UploadPart</code> and <code>UploadPartCopy</code> APIs. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions\">Multipart upload API and permissions</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html\">Protecting data using server-side encryption with Amazon Web Services KMS</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>Encryption</dt> <dd> <ul> <li> <p> <b>General purpose buckets</b> - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. Amazon S3 automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a multipart upload, if you don't specify encryption information in your request, the encryption setting of the uploaded parts is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use a different type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the object with a different encryption key (such as an Amazon S3 managed key, a KMS key, or a customer-provided key). When the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. If you choose to provide your own encryption key, the request headers you provide in <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a> requests must match the headers you used in the <code>CreateMultipartUpload</code> request.</p> <ul> <li> <p>Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (<code>aws/s3</code>) and KMS customer managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.</p> <ul> <li> <p> <code>x-amz-server-side-encryption</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-aws-kms-key-id</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-context</code> </p> </li> </ul> <note> <ul> <li> <p>If you specify <code>x-amz-server-side-encryption:aws:kms</code>, but don't provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code> key) in KMS to protect the data.</p> </li> <li> <p>To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey*</code> actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions\">Multipart upload API and permissions</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html\">Protecting data using server-side encryption with Amazon Web Services KMS</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role is in a different account from the key, then you must have the permissions on both the key policy and your IAM user or role.</p> </li> <li> <p>All <code>GET</code> and <code>PUT</code> requests for an object protected by KMS fail if you don't make them by using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version\">Specifying the Signature Version in Request Authentication</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <p>For more information about server-side encryption with KMS keys (SSE-KMS), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html\">Protecting Data Using Server-Side Encryption with KMS keys</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p>Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption keys, provide all the following headers in the request.</p> <ul> <li> <p> <code>x-amz-server-side-encryption-customer-algorithm</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key-MD5</code> </p> </li> </ul> <p>For more information about server-side encryption with customer-provided encryption keys (SSE-C), see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html\"> Protecting data using server-side encryption with customer-provided encryption keys (SSE-C)</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html\">Specifying server-side encryption with KMS for new object uploads</a>.</p> <p>In the Zonal endpoint API calls (except <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a>) using the REST API, the encryption request headers must match the encryption settings that are specified in the <code>CreateSession</code> request. You can't override the values of the encryption settings (<code>x-amz-server-side-encryption</code>, <code>x-amz-server-side-encryption-aws-kms-key-id</code>, <code>x-amz-server-side-encryption-context</code>, and <code>x-amz-server-side-encryption-bucket-key-enabled</code>) that are specified in the <code>CreateSession</code> request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the <code>CreateSession</code> request to protect new objects in the directory bucket. </p> <note> <p>When you use the CLI or the Amazon Web Services SDKs, for <code>CreateSession</code>, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the <code>CreateSession</code> request. It's not supported to override the encryption settings values in the <code>CreateSession</code> request. So in the Zonal endpoint API calls (except <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a>), the encryption request headers must match the default encryption configuration of the directory bucket. </p> </note> <note> <p>For directory buckets, when you perform a <code>CreateMultipartUpload</code> operation and an <code>UploadPartCopy</code> operation, the request headers you provide in the <code>CreateMultipartUpload</code> request must match the default encryption configuration of the destination bucket. </p> </note> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>CreateMultipartUpload</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>", "alias":"InitiateMultipartUpload" }, "CreateSession":{ @@ -321,7 +321,7 @@ "input":{"shape":"DeleteObjectRequest"}, "output":{"shape":"DeleteObjectOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html", - "documentation":"<p>Removes an object from a bucket. The behavior depends on the bucket's versioning state: </p> <ul> <li> <p>If bucket versioning is not enabled, the operation permanently deletes the object.</p> </li> <li> <p>If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s <code>versionId</code> in the request. For more information about versioning-enabled buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html\">Deleting object versions from a versioning-enabled bucket</a>.</p> </li> <li> <p>If bucket versioning is suspended, the operation removes the object that has a null <code>versionId</code>, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a null <code>versionId</code>, and all versions of the object have a <code>versionId</code>, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has a <code>versionId</code>, you must include the object’s <code>versionId</code> in the request. For more information about versioning-suspended buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html\">Deleting objects from versioning-suspended buckets</a>.</p> </li> </ul> <note> <ul> <li> <p> <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code> to the <code>versionId</code> query parameter in the request.</p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <p>To remove a specific version, you must use the <code>versionId</code> query parameter. Using this query parameter permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header <code>x-amz-delete-marker</code> to true. </p> <p>If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request header in the DELETE <code>versionId</code> request. Requests that include <code>x-amz-mfa</code> must use HTTPS. For more information about MFA Delete, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html\">Using MFA Delete</a> in the <i>Amazon S3 User Guide</i>. To see sample requests that use versioning, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete\">Sample Request</a>. </p> <note> <p> <b>Directory buckets</b> - MFA delete is not supported by directory buckets.</p> </note> <p>You can delete objects by explicitly calling DELETE Object or calling (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html\">PutBucketLifecycle</a>) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the <code>s3:DeleteObject</code>, <code>s3:DeleteObjectVersion</code>, and <code>s3:PutLifeCycleConfiguration</code> actions. </p> <note> <p> <b>Directory buckets</b> - S3 Lifecycle is not supported by directory buckets.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - The following permissions are required in your policies when your <code>DeleteObjects</code> request includes specific headers.</p> <ul> <li> <p> <b> <code>s3:DeleteObject</code> </b> - To delete an object from a bucket, you must always have the <code>s3:DeleteObject</code> permission.</p> </li> <li> <p> <b> <code>s3:DeleteObjectVersion</code> </b> - To delete a specific version of an object from a versioning-enabled bucket, you must have the <code>s3:DeleteObjectVersion</code> permission.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following action is related to <code>DeleteObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> </ul>" + "documentation":"<p>Removes an object from a bucket. The behavior depends on the bucket's versioning state: </p> <ul> <li> <p>If bucket versioning is not enabled, the operation permanently deletes the object.</p> </li> <li> <p>If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the object’s <code>versionId</code> in the request. For more information about versioning-enabled buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html\">Deleting object versions from a versioning-enabled bucket</a>.</p> </li> <li> <p>If bucket versioning is suspended, the operation removes the object that has a null <code>versionId</code>, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a null <code>versionId</code>, and all versions of the object have a <code>versionId</code>, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has a <code>versionId</code>, you must include the object’s <code>versionId</code> in the request. For more information about versioning-suspended buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html\">Deleting objects from versioning-suspended buckets</a>.</p> </li> </ul> <note> <ul> <li> <p> <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code> to the <code>versionId</code> query parameter in the request.</p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <p>To remove a specific version, you must use the <code>versionId</code> query parameter. Using this query parameter permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header <code>x-amz-delete-marker</code> to true. </p> <p>If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request header in the DELETE <code>versionId</code> request. Requests that include <code>x-amz-mfa</code> must use HTTPS. For more information about MFA Delete, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html\">Using MFA Delete</a> in the <i>Amazon S3 User Guide</i>. To see sample requests that use versioning, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete\">Sample Request</a>. </p> <note> <p> <b>Directory buckets</b> - MFA delete is not supported by directory buckets.</p> </note> <p>You can delete objects by explicitly calling DELETE Object or calling (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html\">PutBucketLifecycle</a>) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the <code>s3:DeleteObject</code>, <code>s3:DeleteObjectVersion</code>, and <code>s3:PutLifeCycleConfiguration</code> actions. </p> <note> <p> <b>Directory buckets</b> - S3 Lifecycle is not supported by directory buckets.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - The following permissions are required in your policies when your <code>DeleteObjects</code> request includes specific headers.</p> <ul> <li> <p> <b> <code>s3:DeleteObject</code> </b> - To delete an object from a bucket, you must always have the <code>s3:DeleteObject</code> permission.</p> </li> <li> <p> <b> <code>s3:DeleteObjectVersion</code> </b> - To delete a specific version of an object from a versioning-enabled bucket, you must have the <code>s3:DeleteObjectVersion</code> permission.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following action is related to <code>DeleteObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> </ul>" }, "DeleteObjectTagging":{ "name":"DeleteObjectTagging", @@ -343,7 +343,7 @@ "input":{"shape":"DeleteObjectsRequest"}, "output":{"shape":"DeleteObjectsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html", - "documentation":"<p>This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.</p> <p>The request can contain a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.</p> <note> <ul> <li> <p> <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets.</p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <p>The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion in a quiet mode, the operation does not return any information about the delete in the response body.</p> <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete\">MFA Delete</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory buckets</b> - MFA delete is not supported by directory buckets.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - The following permissions are required in your policies when your <code>DeleteObjects</code> request includes specific headers.</p> <ul> <li> <p> <b> <code>s3:DeleteObject</code> </b> - To delete an object from a bucket, you must always specify the <code>s3:DeleteObject</code> permission.</p> </li> <li> <p> <b> <code>s3:DeleteObjectVersion</code> </b> - To delete a specific version of an object from a versioning-enabled bucket, you must specify the <code>s3:DeleteObjectVersion</code> permission.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>Content-MD5 request header</dt> <dd> <ul> <li> <p> <b>General purpose bucket</b> - The Content-MD5 request header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.</p> </li> <li> <p> <b>Directory bucket</b> - The Content-MD5 request header or a additional checksum request header (including <code>x-amz-checksum-crc32</code>, <code>x-amz-checksum-crc32c</code>, <code>x-amz-checksum-sha1</code>, or <code>x-amz-checksum-sha256</code>) is required for all Multi-Object Delete requests.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>DeleteObjects</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> </ul>", + "documentation":"<p>This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.</p> <p>The request can contain a list of up to 1,000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success or failure, in the response. If the object specified in the request isn't found, Amazon S3 confirms the deletion by returning the result as deleted.</p> <note> <ul> <li> <p> <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets.</p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <p>The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion in a quiet mode, the operation does not return any information about the delete in the response body.</p> <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete\">MFA Delete</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory buckets</b> - MFA delete is not supported by directory buckets.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - The following permissions are required in your policies when your <code>DeleteObjects</code> request includes specific headers.</p> <ul> <li> <p> <b> <code>s3:DeleteObject</code> </b> - To delete an object from a bucket, you must always specify the <code>s3:DeleteObject</code> permission.</p> </li> <li> <p> <b> <code>s3:DeleteObjectVersion</code> </b> - To delete a specific version of an object from a versioning-enabled bucket, you must specify the <code>s3:DeleteObjectVersion</code> permission.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>Content-MD5 request header</dt> <dd> <ul> <li> <p> <b>General purpose bucket</b> - The Content-MD5 request header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.</p> </li> <li> <p> <b>Directory bucket</b> - The Content-MD5 request header or a additional checksum request header (including <code>x-amz-checksum-crc32</code>, <code>x-amz-checksum-crc32c</code>, <code>x-amz-checksum-sha1</code>, or <code>x-amz-checksum-sha256</code>) is required for all Multi-Object Delete requests.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>DeleteObjects</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> </ul>", "alias":"DeleteMultipleObjects", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", @@ -688,10 +688,11 @@ {"shape":"InvalidObjectState"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html", - "documentation":"<p>Retrieves an object from Amazon S3.</p> <p>In the <code>GetObject</code> request, specify the full key name for the object.</p> <p> <b>General purpose buckets</b> - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket</code>, specify the object key name as <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about request types, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket\">HTTP Host Header Bucket Specification</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Directory buckets</b> - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket--use1-az5--x-s3</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - You must have the required permissions in a policy. To use <code>GetObject</code>, you must have the <code>READ</code> access to the object (or version). If you grant <code>READ</code> access to the anonymous user, the <code>GetObject</code> operation returns the object without using an authorization header. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying permissions in a policy</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you include a <code>versionId</code> in your request header, you must have the <code>s3:GetObjectVersion</code> permission to access a specific version of an object. The <code>s3:GetObject</code> permission is not required in this scenario.</p> <p>If you request the current version of an object without a specific <code>versionId</code> in the request header, only the <code>s3:GetObject</code> permission is required. The <code>s3:GetObjectVersion</code> permission is not required in this scenario. </p> <p>If the object that you request doesn’t exist, the error that Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an HTTP status code <code>404 Not Found</code> error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP status code <code>403 Access Denied</code> error.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If the object is encrypted using SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> </li> </ul> </dd> <dt>Storage classes</dt> <dd> <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html\">RestoreObject</a>. Otherwise, this operation returns an <code>InvalidObjectState</code> error. For information about restoring archived objects, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html\">Restoring Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Directory buckets </b> - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won't write a destination object and will respond with the HTTP status code <code>400 Bad Request</code>.</p> </dd> <dt>Encryption</dt> <dd> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for the <code>GetObject</code> requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your <code>GetObject</code> requests for the object that uses these types of keys, you’ll get an HTTP <code>400 Bad Request</code> error.</p> <p> <b>Directory buckets</b> - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>.</p> </dd> <dt>Overriding response header values through the request</dt> <dd> <p>There are times when you want to override certain response header values of a <code>GetObject</code> response. For example, you might override the <code>Content-Disposition</code> response header value through your <code>GetObject</code> request.</p> <p>You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code <code>200 OK</code> is returned. The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object. </p> <p>The response headers that you can override for the <code>GetObject</code> response are <code>Cache-Control</code>, <code>Content-Disposition</code>, <code>Content-Encoding</code>, <code>Content-Language</code>, <code>Content-Type</code>, and <code>Expires</code>.</p> <p>To override values for a set of response headers in the <code>GetObject</code> response, you can use the following query parameters in the request.</p> <ul> <li> <p> <code>response-cache-control</code> </p> </li> <li> <p> <code>response-content-disposition</code> </p> </li> <li> <p> <code>response-content-encoding</code> </p> </li> <li> <p> <code>response-content-language</code> </p> </li> <li> <p> <code>response-content-type</code> </p> </li> <li> <p> <code>response-expires</code> </p> </li> </ul> <note> <p>When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.</p> </note> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>GetObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html\">ListBuckets</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html\">GetObjectAcl</a> </p> </li> </ul>", + "documentation":"<p>Retrieves an object from Amazon S3.</p> <p>In the <code>GetObject</code> request, specify the full key name for the object.</p> <p> <b>General purpose buckets</b> - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. For a path-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>examplebucket</code>, specify the object key name as <code>/examplebucket/photos/2006/February/sample.jpg</code>. For more information about request types, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket\">HTTP Host Header Bucket Specification</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Directory buckets</b> - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object <code>photos/2006/February/sample.jpg</code> in the bucket named <code>amzn-s3-demo-bucket--usw2-az1--x-s3</code>, specify the object key name as <code>/photos/2006/February/sample.jpg</code>. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - You must have the required permissions in a policy. To use <code>GetObject</code>, you must have the <code>READ</code> access to the object (or version). If you grant <code>READ</code> access to the anonymous user, the <code>GetObject</code> operation returns the object without using an authorization header. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying permissions in a policy</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you include a <code>versionId</code> in your request header, you must have the <code>s3:GetObjectVersion</code> permission to access a specific version of an object. The <code>s3:GetObject</code> permission is not required in this scenario.</p> <p>If you request the current version of an object without a specific <code>versionId</code> in the request header, only the <code>s3:GetObject</code> permission is required. The <code>s3:GetObjectVersion</code> permission is not required in this scenario. </p> <p>If the object that you request doesn’t exist, the error that Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an HTTP status code <code>404 Not Found</code> error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP status code <code>403 Access Denied</code> error.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If the object is encrypted using SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> </li> </ul> </dd> <dt>Storage classes</dt> <dd> <p>If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html\">RestoreObject</a>. Otherwise, this operation returns an <code>InvalidObjectState</code> error. For information about restoring archived objects, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html\">Restoring Archived Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Directory buckets </b> - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won't write a destination object and will respond with the HTTP status code <code>400 Bad Request</code>.</p> </dd> <dt>Encryption</dt> <dd> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for the <code>GetObject</code> requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your <code>GetObject</code> requests for the object that uses these types of keys, you’ll get an HTTP <code>400 Bad Request</code> error.</p> <p> <b>Directory buckets</b> - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>.</p> </dd> <dt>Overriding response header values through the request</dt> <dd> <p>There are times when you want to override certain response header values of a <code>GetObject</code> response. For example, you might override the <code>Content-Disposition</code> response header value through your <code>GetObject</code> request.</p> <p>You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code <code>200 OK</code> is returned. The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object. </p> <p>The response headers that you can override for the <code>GetObject</code> response are <code>Cache-Control</code>, <code>Content-Disposition</code>, <code>Content-Encoding</code>, <code>Content-Language</code>, <code>Content-Type</code>, and <code>Expires</code>.</p> <p>To override values for a set of response headers in the <code>GetObject</code> response, you can use the following query parameters in the request.</p> <ul> <li> <p> <code>response-cache-control</code> </p> </li> <li> <p> <code>response-content-disposition</code> </p> </li> <li> <p> <code>response-content-encoding</code> </p> </li> <li> <p> <code>response-content-language</code> </p> </li> <li> <p> <code>response-content-type</code> </p> </li> <li> <p> <code>response-expires</code> </p> </li> </ul> <note> <p>When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.</p> </note> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>GetObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html\">ListBuckets</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html\">GetObjectAcl</a> </p> </li> </ul>", "httpChecksum":{ "requestValidationModeMember":"ChecksumMode", "responseAlgorithms":[ + "CRC64NVME", "CRC32", "CRC32C", "SHA256", @@ -724,7 +725,7 @@ "errors":[ {"shape":"NoSuchKey"} ], - "documentation":"<p>Retrieves all the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata. </p> <p> <code>GetObjectAttributes</code> combines the functionality of <code>HeadObject</code> and <code>ListParts</code>. All of the data returned with each of those individual calls can be returned with a single call to <code>GetObjectAttributes</code>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - To use <code>GetObjectAttributes</code>, you must have READ access to the object. The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the <code>s3:GetObjectVersion</code> and <code>s3:GetObjectVersionAttributes</code> permissions for this operation. If the bucket is not versioned, you need the <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code> permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an HTTP status code <code>404 Not Found</code> (\"no such key\") error.</p> </li> <li> <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP status code <code>403 Forbidden</code> (\"access denied\") error.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> </li> </ul> </dd> <dt>Encryption</dt> <dd> <note> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for <code>HEAD</code> requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The <code>x-amz-server-side-encryption</code> header is used when you <code>PUT</code> an object to S3 and want to specify the encryption method. If you include this header in a <code>GET</code> request for an object that uses these types of keys, you’ll get an HTTP <code>400 Bad Request</code> error. It's because the encryption method can't be changed when you retrieve the object.</p> </note> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are: </p> <ul> <li> <p> <code>x-amz-server-side-encryption-customer-algorithm</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key-MD5</code> </p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory bucket permissions</b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html\">Specifying server-side encryption with KMS for new object uploads</a>.</p> </note> </dd> <dt>Versioning</dt> <dd> <p> <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code> to the <code>versionId</code> query parameter in the request.</p> </dd> <dt>Conditional request headers</dt> <dd> <p>Consider the following when using request headers:</p> <ul> <li> <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows, then Amazon S3 returns the HTTP status code <code>200 OK</code> and the data requested:</p> <ul> <li> <p> <code>If-Match</code> condition evaluates to <code>true</code>.</p> </li> <li> <p> <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>.</p> </li> </ul> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> </li> <li> <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows, then Amazon S3 returns the HTTP status code <code>304 Not Modified</code>:</p> <ul> <li> <p> <code>If-None-Match</code> condition evaluates to <code>false</code>.</p> </li> <li> <p> <code>If-Modified-Since</code> condition evaluates to <code>true</code>.</p> </li> </ul> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following actions are related to <code>GetObjectAttributes</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html\">GetObjectAcl</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html\">GetObjectLegalHold</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html\">GetObjectLockConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html\">GetObjectRetention</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html\">GetObjectTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html\">HeadObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> </ul>" + "documentation":"<p>Retrieves all the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata. </p> <p> <code>GetObjectAttributes</code> combines the functionality of <code>HeadObject</code> and <code>ListParts</code>. All of the data returned with each of those individual calls can be returned with a single call to <code>GetObjectAttributes</code>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - To use <code>GetObjectAttributes</code>, you must have READ access to the object. The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the <code>s3:GetObjectVersion</code> and <code>s3:GetObjectVersionAttributes</code> permissions for this operation. If the bucket is not versioned, you need the <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code> permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a> in the <i>Amazon S3 User Guide</i>. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an HTTP status code <code>404 Not Found</code> (\"no such key\") error.</p> </li> <li> <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP status code <code>403 Forbidden</code> (\"access denied\") error.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> </li> </ul> </dd> <dt>Encryption</dt> <dd> <note> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for <code>HEAD</code> requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The <code>x-amz-server-side-encryption</code> header is used when you <code>PUT</code> an object to S3 and want to specify the encryption method. If you include this header in a <code>GET</code> request for an object that uses these types of keys, you’ll get an HTTP <code>400 Bad Request</code> error. It's because the encryption method can't be changed when you retrieve the object.</p> </note> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are: </p> <ul> <li> <p> <code>x-amz-server-side-encryption-customer-algorithm</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key-MD5</code> </p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory bucket permissions</b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. For more information about the encryption overriding behaviors in directory buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html\">Specifying server-side encryption with KMS for new object uploads</a>.</p> </note> </dd> <dt>Versioning</dt> <dd> <p> <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code> to the <code>versionId</code> query parameter in the request.</p> </dd> <dt>Conditional request headers</dt> <dd> <p>Consider the following when using request headers:</p> <ul> <li> <p>If both of the <code>If-Match</code> and <code>If-Unmodified-Since</code> headers are present in the request as follows, then Amazon S3 returns the HTTP status code <code>200 OK</code> and the data requested:</p> <ul> <li> <p> <code>If-Match</code> condition evaluates to <code>true</code>.</p> </li> <li> <p> <code>If-Unmodified-Since</code> condition evaluates to <code>false</code>.</p> </li> </ul> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> </li> <li> <p>If both of the <code>If-None-Match</code> and <code>If-Modified-Since</code> headers are present in the request as follows, then Amazon S3 returns the HTTP status code <code>304 Not Modified</code>:</p> <ul> <li> <p> <code>If-None-Match</code> condition evaluates to <code>false</code>.</p> </li> <li> <p> <code>If-Modified-Since</code> condition evaluates to <code>true</code>.</p> </li> </ul> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following actions are related to <code>GetObjectAttributes</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html\">GetObjectAcl</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html\">GetObjectLegalHold</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html\">GetObjectLockConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html\">GetObjectRetention</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html\">GetObjectTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html\">HeadObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> </ul>" }, "GetObjectLegalHold":{ "name":"GetObjectLegalHold", @@ -816,7 +817,7 @@ {"shape":"NoSuchKey"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html", - "documentation":"<p>The <code>HEAD</code> operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.</p> <note> <p>A <code>HEAD</code> request has the same options as a <code>GET</code> operation on an object. The response is identical to the <code>GET</code> response except that there is no response body. Because of this, if the <code>HEAD</code> request generates an error, it returns a generic code, such as <code>400 Bad Request</code>, <code>403 Forbidden</code>, <code>404 Not Found</code>, <code>405 Method Not Allowed</code>, <code>412 Precondition Failed</code>, or <code>304 Not Modified</code>. It's not possible to retrieve the exact exception of these error codes.</p> </note> <p>Request headers are limited to 8 KB in size. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html\">Common Request Headers</a>.</p> <dl> <dt>Permissions</dt> <dd> <p/> <ul> <li> <p> <b>General purpose bucket permissions</b> - To use <code>HEAD</code>, you must have the <code>s3:GetObject</code> permission. You need the relevant read object (or version) permission for this operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html\">Actions, resources, and condition keys for Amazon S3</a> in the <i>Amazon S3 User Guide</i>. For more information about the permissions to S3 API operations by S3 resource types, see <a href=\"/AmazonS3/latest/userguide/using-with-s3-policy-actions.html\">Required permissions for Amazon S3 API operations</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If the object you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an HTTP status code <code>404 Not Found</code> error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP status code <code>403 Forbidden</code> error.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If you enable <code>x-amz-checksum-mode</code> in the request and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.</p> </li> </ul> </dd> <dt>Encryption</dt> <dd> <note> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for <code>HEAD</code> requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The <code>x-amz-server-side-encryption</code> header is used when you <code>PUT</code> an object to S3 and want to specify the encryption method. If you include this header in a <code>HEAD</code> request for an object that uses these types of keys, you’ll get an HTTP <code>400 Bad Request</code> error. It's because the encryption method can't be changed when you retrieve the object.</p> </note> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are: </p> <ul> <li> <p> <code>x-amz-server-side-encryption-customer-algorithm</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key-MD5</code> </p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory bucket </b> - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. </p> </note> </dd> <dt>Versioning</dt> <dd> <ul> <li> <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes <code>x-amz-delete-marker: true</code> in the response.</p> </li> <li> <p>If the specified version is a delete marker, the response returns a <code>405 Method Not Allowed</code> error and the <code>Last-Modified: timestamp</code> response header.</p> </li> </ul> <note> <ul> <li> <p> <b>Directory buckets</b> - Delete marker is not supported for directory buckets.</p> </li> <li> <p> <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code> to the <code>versionId</code> query parameter in the request.</p> </li> </ul> </note> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> <note> <p>For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> </dd> </dl> <p>The following actions are related to <code>HeadObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> </ul>" + "documentation":"<p>The <code>HEAD</code> operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.</p> <note> <p>A <code>HEAD</code> request has the same options as a <code>GET</code> operation on an object. The response is identical to the <code>GET</code> response except that there is no response body. Because of this, if the <code>HEAD</code> request generates an error, it returns a generic code, such as <code>400 Bad Request</code>, <code>403 Forbidden</code>, <code>404 Not Found</code>, <code>405 Method Not Allowed</code>, <code>412 Precondition Failed</code>, or <code>304 Not Modified</code>. It's not possible to retrieve the exact exception of these error codes.</p> </note> <p>Request headers are limited to 8 KB in size. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html\">Common Request Headers</a>.</p> <dl> <dt>Permissions</dt> <dd> <p/> <ul> <li> <p> <b>General purpose bucket permissions</b> - To use <code>HEAD</code>, you must have the <code>s3:GetObject</code> permission. You need the relevant read object (or version) permission for this operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html\">Actions, resources, and condition keys for Amazon S3</a> in the <i>Amazon S3 User Guide</i>. For more information about the permissions to S3 API operations by S3 resource types, see <a href=\"/AmazonS3/latest/userguide/using-with-s3-policy-actions.html\">Required permissions for Amazon S3 API operations</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If the object you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the <code>s3:ListBucket</code> permission.</p> <ul> <li> <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3 returns an HTTP status code <code>404 Not Found</code> error.</p> </li> <li> <p>If you don’t have the <code>s3:ListBucket</code> permission, Amazon S3 returns an HTTP status code <code>403 Forbidden</code> error.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If you enable <code>x-amz-checksum-mode</code> in the request and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.</p> </li> </ul> </dd> <dt>Encryption</dt> <dd> <note> <p>Encryption request headers, like <code>x-amz-server-side-encryption</code>, should not be sent for <code>HEAD</code> requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The <code>x-amz-server-side-encryption</code> header is used when you <code>PUT</code> an object to S3 and want to specify the encryption method. If you include this header in a <code>HEAD</code> request for an object that uses these types of keys, you’ll get an HTTP <code>400 Bad Request</code> error. It's because the encryption method can't be changed when you retrieve the object.</p> </note> <p>If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are: </p> <ul> <li> <p> <code>x-amz-server-side-encryption-customer-algorithm</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key</code> </p> </li> <li> <p> <code>x-amz-server-side-encryption-customer-key-MD5</code> </p> </li> </ul> <p>For more information about SSE-C, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\">Server-Side Encryption (Using Customer-Provided Encryption Keys)</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory bucket </b> - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>. </p> </note> </dd> <dt>Versioning</dt> <dd> <ul> <li> <p>If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes <code>x-amz-delete-marker: true</code> in the response.</p> </li> <li> <p>If the specified version is a delete marker, the response returns a <code>405 Method Not Allowed</code> error and the <code>Last-Modified: timestamp</code> response header.</p> </li> </ul> <note> <ul> <li> <p> <b>Directory buckets</b> - Delete marker is not supported for directory buckets.</p> </li> <li> <p> <b>Directory buckets</b> - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the <code>null</code> value of the version ID is supported by directory buckets. You can only specify <code>null</code> to the <code>versionId</code> query parameter in the request.</p> </li> </ul> </note> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> <note> <p>For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> </dd> </dl> <p>The following actions are related to <code>HeadObject</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> </ul>" }, "ListBucketAnalyticsConfigurations":{ "name":"ListBucketAnalyticsConfigurations", @@ -901,7 +902,7 @@ "input":{"shape":"ListMultipartUploadsRequest"}, "output":{"shape":"ListMultipartUploadsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html", - "documentation":"<p>This operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a multipart upload that has been initiated by the <code>CreateMultipartUpload</code> request, but has not yet been completed or aborted.</p> <note> <p> <b>Directory buckets</b> - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed. To delete these in-progress multipart uploads, use the <code>ListMultipartUploads</code> operation to list the in-progress multipart uploads in the bucket and use the <code>AbortMultipartUpload</code> operation to abort all the in-progress multipart uploads. </p> </note> <p>The <code>ListMultipartUploads</code> operation returns a maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart uploads is also the default value. You can further limit the number of uploads in a response by specifying the <code>max-uploads</code> request parameter. If there are more than 1,000 multipart uploads that satisfy your <code>ListMultipartUploads</code> request, the response returns an <code>IsTruncated</code> element with the value of <code>true</code>, a <code>NextKeyMarker</code> element, and a <code>NextUploadIdMarker</code> element. To list the remaining multipart uploads, you need to make subsequent <code>ListMultipartUploads</code> requests. In these requests, include two query parameters: <code>key-marker</code> and <code>upload-id-marker</code>. Set the value of <code>key-marker</code> to the <code>NextKeyMarker</code> value from the previous response. Similarly, set the value of <code>upload-id-marker</code> to the <code>NextUploadIdMarker</code> value from the previous response.</p> <note> <p> <b>Directory buckets</b> - The <code>upload-id-marker</code> element and the <code>NextUploadIdMarker</code> element aren't supported by directory buckets. To list the additional multipart uploads, you only need to set the value of <code>key-marker</code> to the <code>NextKeyMarker</code> value from the previous response. </p> </note> <p>For more information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>Sorting of multipart uploads in response</dt> <dd> <ul> <li> <p> <b>General purpose bucket</b> - In the <code>ListMultipartUploads</code> response, the multipart uploads are sorted based on two criteria:</p> <ul> <li> <p>Key-based sorting - Multipart uploads are initially sorted in ascending order based on their object keys.</p> </li> <li> <p>Time-based sorting - For uploads that share the same object key, they are further sorted in ascending order based on the upload initiation time. Among uploads with the same key, the one that was initiated first will appear before the ones that were initiated later.</p> </li> </ul> </li> <li> <p> <b>Directory bucket</b> - In the <code>ListMultipartUploads</code> response, the multipart uploads aren't sorted lexicographically based on the object keys. </p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>ListMultipartUploads</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> </ul>" + "documentation":"<p>This operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a multipart upload that has been initiated by the <code>CreateMultipartUpload</code> request, but has not yet been completed or aborted.</p> <note> <p> <b>Directory buckets</b> - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed. To delete these in-progress multipart uploads, use the <code>ListMultipartUploads</code> operation to list the in-progress multipart uploads in the bucket and use the <code>AbortMultipartUpload</code> operation to abort all the in-progress multipart uploads. </p> </note> <p>The <code>ListMultipartUploads</code> operation returns a maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart uploads is also the default value. You can further limit the number of uploads in a response by specifying the <code>max-uploads</code> request parameter. If there are more than 1,000 multipart uploads that satisfy your <code>ListMultipartUploads</code> request, the response returns an <code>IsTruncated</code> element with the value of <code>true</code>, a <code>NextKeyMarker</code> element, and a <code>NextUploadIdMarker</code> element. To list the remaining multipart uploads, you need to make subsequent <code>ListMultipartUploads</code> requests. In these requests, include two query parameters: <code>key-marker</code> and <code>upload-id-marker</code>. Set the value of <code>key-marker</code> to the <code>NextKeyMarker</code> value from the previous response. Similarly, set the value of <code>upload-id-marker</code> to the <code>NextUploadIdMarker</code> value from the previous response.</p> <note> <p> <b>Directory buckets</b> - The <code>upload-id-marker</code> element and the <code>NextUploadIdMarker</code> element aren't supported by directory buckets. To list the additional multipart uploads, you only need to set the value of <code>key-marker</code> to the <code>NextKeyMarker</code> value from the previous response. </p> </note> <p>For more information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>Sorting of multipart uploads in response</dt> <dd> <ul> <li> <p> <b>General purpose bucket</b> - In the <code>ListMultipartUploads</code> response, the multipart uploads are sorted based on two criteria:</p> <ul> <li> <p>Key-based sorting - Multipart uploads are initially sorted in ascending order based on their object keys.</p> </li> <li> <p>Time-based sorting - For uploads that share the same object key, they are further sorted in ascending order based on the upload initiation time. Among uploads with the same key, the one that was initiated first will appear before the ones that were initiated later.</p> </li> </ul> </li> <li> <p> <b>Directory bucket</b> - In the <code>ListMultipartUploads</code> response, the multipart uploads aren't sorted lexicographically based on the object keys. </p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>ListMultipartUploads</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> </ul>" }, "ListObjectVersions":{ "name":"ListObjectVersions", @@ -941,7 +942,7 @@ "errors":[ {"shape":"NoSuchBucket"} ], - "documentation":"<p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A <code>200 OK</code> response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. For more information about listing objects, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html\">Listing object keys programmatically</a> in the <i>Amazon S3 User Guide</i>. To get a list of your buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html\">ListBuckets</a>.</p> <note> <ul> <li> <p> <b>General purpose bucket</b> - For general purpose buckets, <code>ListObjectsV2</code> doesn't return prefixes that are related only to in-progress multipart uploads.</p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, <code>ListObjectsV2</code> response includes the prefixes that are related only to in-progress multipart uploads. </p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - To use this operation, you must have READ access to the bucket. You must have permission to perform the <code>s3:ListBucket</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>Sorting order of returned objects</dt> <dd> <ul> <li> <p> <b>General purpose bucket</b> - For general purpose buckets, <code>ListObjectsV2</code> returns objects in lexicographical order based on their key names.</p> </li> <li> <p> <b>Directory bucket</b> - For directory buckets, <code>ListObjectsV2</code> does not return objects in lexicographical order.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <important> <p>This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html\">ListObjects</a>.</p> </important> <p>The following operations are related to <code>ListObjectsV2</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> </ul>" + "documentation":"<p>Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A <code>200 OK</code> response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. For more information about listing objects, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html\">Listing object keys programmatically</a> in the <i>Amazon S3 User Guide</i>. To get a list of your buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html\">ListBuckets</a>.</p> <note> <ul> <li> <p> <b>General purpose bucket</b> - For general purpose buckets, <code>ListObjectsV2</code> doesn't return prefixes that are related only to in-progress multipart uploads.</p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, <code>ListObjectsV2</code> response includes the prefixes that are related only to in-progress multipart uploads. </p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - To use this operation, you must have READ access to the bucket. You must have permission to perform the <code>s3:ListBucket</code> action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>Sorting order of returned objects</dt> <dd> <ul> <li> <p> <b>General purpose bucket</b> - For general purpose buckets, <code>ListObjectsV2</code> returns objects in lexicographical order based on their key names.</p> </li> <li> <p> <b>Directory bucket</b> - For directory buckets, <code>ListObjectsV2</code> does not return objects in lexicographical order.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <important> <p>This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html\">ListObjects</a>.</p> </important> <p>The following operations are related to <code>ListObjectsV2</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> </ul>" }, "ListObjectsV1Ext":{ "name":"ListObjectsV1Ext", @@ -965,7 +966,7 @@ "input":{"shape":"ListPartsRequest"}, "output":{"shape":"ListPartsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html", - "documentation":"<p>Lists the parts that have been uploaded for a specific multipart upload.</p> <p>To use this operation, you must provide the <code>upload ID</code> in the request. You obtain this uploadID by sending the initiate multipart upload request through <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>.</p> <p>The <code>ListParts</code> request returns a maximum of 1,000 uploaded parts. The limit of 1,000 parts is also the default value. You can restrict the number of parts in a response by specifying the <code>max-parts</code> request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an <code>IsTruncated</code> field with the value of <code>true</code>, and a <code>NextPartNumberMarker</code> element. To list remaining uploaded parts, in subsequent <code>ListParts</code> requests, include the <code>part-number-marker</code> query string parameter and set its value to the <code>NextPartNumberMarker</code> field value from the previous response.</p> <p>For more information on multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If the upload was created using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the <code>kms:Decrypt</code> action for the <code>ListParts</code> request to succeed.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>ListParts</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>" + "documentation":"<p>Lists the parts that have been uploaded for a specific multipart upload.</p> <p>To use this operation, you must provide the <code>upload ID</code> in the request. You obtain this uploadID by sending the initiate multipart upload request through <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>.</p> <p>The <code>ListParts</code> request returns a maximum of 1,000 uploaded parts. The limit of 1,000 parts is also the default value. You can restrict the number of parts in a response by specifying the <code>max-parts</code> request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an <code>IsTruncated</code> field with the value of <code>true</code>, and a <code>NextPartNumberMarker</code> element. To list remaining uploaded parts, in subsequent <code>ListParts</code> requests, include the <code>part-number-marker</code> query string parameter and set its value to the <code>NextPartNumberMarker</code> field value from the previous response.</p> <p>For more information on multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - For information about permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart Upload and Permissions</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If the upload was created using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the <code>kms:Decrypt</code> action for the <code>ListParts</code> request to succeed.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>ListParts</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html\">GetObjectAttributes</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>" }, "PutBucketAccelerateConfiguration":{ "name":"PutBucketAccelerateConfiguration", @@ -1036,7 +1037,7 @@ "requestUri":"/{Bucket}?encryption" }, "input":{"shape":"PutBucketEncryptionRequest"}, - "documentation":"<p>This operation configures default encryption and Amazon S3 Bucket Keys for an existing bucket.</p> <note> <p> <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i> </code>. Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p>By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3).</p> <note> <ul> <li> <p> <b>General purpose buckets</b> </p> <ul> <li> <p>You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also configure <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html\">Amazon S3 Bucket Keys</a>. For information about the bucket default encryption feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html\">Amazon S3 Bucket Default Encryption</a> in the <i>Amazon S3 User Guide</i>. </p> </li> <li> <p>If you use PutBucketEncryption to set your <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html\">default bucket encryption</a> to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 doesn't validate the KMS key ID provided in PutBucketEncryption requests.</p> </li> </ul> </li> <li> <p> <b>Directory buckets </b> - You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p> <ul> <li> <p>We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information about the encryption overriding behaviors in directory buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html\">Specifying server-side encryption with KMS for new object uploads</a>.</p> </li> <li> <p>Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket for the lifetime of the bucket. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. </p> </li> <li> <p>S3 Bucket Keys are always enabled for <code>GET</code> and <code>PUT</code> operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a>, <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a>, <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops\">the Copy operation in Batch Operations</a>, or <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job\">the import jobs</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p> </li> <li> <p>When you specify an <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">KMS customer managed key</a> for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.</p> </li> <li> <p>For directory buckets, if you use PutBucketEncryption to set your <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html\">default bucket encryption</a> to SSE-KMS, Amazon S3 validates the KMS key ID provided in PutBucketEncryption requests.</p> </li> </ul> </li> </ul> </note> <important> <p>If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.</p> <p>Also, this action requires Amazon Web Services Signature Version 4. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\"> Authenticating Requests (Amazon Web Services Signature Version 4)</a>. </p> </important> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - The <code>s3:PutEncryptionConfiguration</code> permission is required in a policy. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation, you must have the <code>s3express:PutEncryptionConfiguration</code> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html\">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p> <p>To set a directory bucket default encryption with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and the <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the target KMS key.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>PutBucketEncryption</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html\">GetBucketEncryption</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html\">DeleteBucketEncryption</a> </p> </li> </ul>", + "documentation":"<p>This operation configures default encryption and Amazon S3 Bucket Keys for an existing bucket.</p> <note> <p> <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i> </code>. Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p>By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3).</p> <note> <ul> <li> <p> <b>General purpose buckets</b> </p> <ul> <li> <p>You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also configure <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html\">Amazon S3 Bucket Keys</a>. For information about the bucket default encryption feature, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html\">Amazon S3 Bucket Default Encryption</a> in the <i>Amazon S3 User Guide</i>. </p> </li> <li> <p>If you use PutBucketEncryption to set your <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html\">default bucket encryption</a> to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 doesn't validate the KMS key ID provided in PutBucketEncryption requests.</p> </li> </ul> </li> <li> <p> <b>Directory buckets </b> - You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p> <ul> <li> <p>We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your <code>CreateSession</code> requests or <code>PUT</code> object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information about the encryption overriding behaviors in directory buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html\">Specifying server-side encryption with KMS for new object uploads</a>.</p> </li> <li> <p>Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket's lifetime. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. </p> </li> <li> <p>S3 Bucket Keys are always enabled for <code>GET</code> and <code>PUT</code> operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a>, <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a>, <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops\">the Copy operation in Batch Operations</a>, or <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job\">the import jobs</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p> </li> <li> <p>When you specify an <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">KMS customer managed key</a> for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.</p> </li> <li> <p>For directory buckets, if you use PutBucketEncryption to set your <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html\">default bucket encryption</a> to SSE-KMS, Amazon S3 validates the KMS key ID provided in PutBucketEncryption requests.</p> </li> </ul> </li> </ul> </note> <important> <p>If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.</p> <p>Also, this action requires Amazon Web Services Signature Version 4. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html\"> Authenticating Requests (Amazon Web Services Signature Version 4)</a>. </p> </important> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - The <code>s3:PutEncryptionConfiguration</code> permission is required in a policy. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation, you must have the <code>s3express:PutEncryptionConfiguration</code> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html\">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p> <p>To set a directory bucket default encryption with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and the <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the target KMS key.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>PutBucketEncryption</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html\">GetBucketEncryption</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html\">DeleteBucketEncryption</a> </p> </li> </ul>", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true @@ -1077,7 +1078,7 @@ }, "input":{"shape":"PutBucketLifecycleRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html", - "documentation":"<important> <p>For an updated version of this API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a>. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. </p> </important> <note> <p>This operation is not supported for directory buckets.</p> </note> <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a> in the <i>Amazon S3 User Guide</i>. </p> <p>By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the <code>s3:PutLifecycleConfiguration</code> permission.</p> <p>You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: </p> <ul> <li> <p> <code>s3:DeleteObject</code> </p> </li> <li> <p> <code>s3:DeleteObjectVersion</code> </p> </li> <li> <p> <code>s3:PutLifecycleConfiguration</code> </p> </li> </ul> <p>For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p>For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples\">Examples of Lifecycle Configuration</a>.</p> <p>The following operations are related to <code>PutBucketLifecycle</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html\">GetBucketLifecycle</a>(Deprecated)</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html\">RestoreObject</a> </p> </li> <li> <p>By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to your Amazon S3 Resources</a> </p> </li> </ul> </li> </ul>", + "documentation":"<note> <p>This operation is not supported for directory buckets.</p> </note> <important> <p>For an updated version of this API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a>. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. </p> </important> <note> <p>This operation is not supported for directory buckets.</p> </note> <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\">Object Lifecycle Management</a> in the <i>Amazon S3 User Guide</i>. </p> <p>By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the <code>s3:PutLifecycleConfiguration</code> permission.</p> <p>You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: </p> <ul> <li> <p> <code>s3:DeleteObject</code> </p> </li> <li> <p> <code>s3:DeleteObjectVersion</code> </p> </li> <li> <p> <code>s3:PutLifecycleConfiguration</code> </p> </li> </ul> <p>For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to your Amazon S3 Resources</a> in the <i>Amazon S3 User Guide</i>.</p> <p>For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples\">Examples of Lifecycle Configuration</a>.</p> <p>The following operations are related to <code>PutBucketLifecycle</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html\">GetBucketLifecycle</a>(Deprecated)</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html\">RestoreObject</a> </p> </li> <li> <p>By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html\">Specifying Permissions in a Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to your Amazon S3 Resources</a> </p> </li> </ul> </li> </ul>", "deprecated":true, "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", @@ -1251,7 +1252,7 @@ }, "input":{"shape":"PutBucketVersioningRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html", - "documentation":"<note> <p>This operation is not supported for directory buckets.</p> </note> <note> <p>When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. While this change is propagating, you may encounter intermittent <code>HTTP 404 NoSuchKey</code> errors for requests to objects created or updated after enabling versioning. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (<code>PUT</code> or <code>DELETE</code>) on objects in the bucket. </p> </note> <p>Sets the versioning state of an existing bucket.</p> <p>You can set the versioning state with one of the following values:</p> <p> <b>Enabled</b>—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.</p> <p> <b>Suspended</b>—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.</p> <p>If the versioning state has never been set on a bucket, it has no versioning state; a <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a> request does not return a versioning state value.</p> <p>In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the <code>x-amz-mfa request</code> header and the <code>Status</code> and the <code>MfaDelete</code> request elements in a request to set the versioning state of the bucket.</p> <important> <p>If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config\">Lifecycle and Versioning</a>.</p> </important> <p>The following operations are related to <code>PutBucketVersioning</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html\">DeleteBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a> </p> </li> </ul>", + "documentation":"<note> <p>This operation is not supported for directory buckets.</p> </note> <note> <p>When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. While this change is propagating, you might encounter intermittent <code>HTTP 404 NoSuchKey</code> errors for requests to objects created or updated after enabling versioning. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (<code>PUT</code> or <code>DELETE</code>) on objects in the bucket. </p> </note> <p>Sets the versioning state of an existing bucket.</p> <p>You can set the versioning state with one of the following values:</p> <p> <b>Enabled</b>—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.</p> <p> <b>Suspended</b>—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.</p> <p>If the versioning state has never been set on a bucket, it has no versioning state; a <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a> request does not return a versioning state value.</p> <p>In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the <code>x-amz-mfa request</code> header and the <code>Status</code> and the <code>MfaDelete</code> request elements in a request to set the versioning state of the bucket.</p> <important> <p>If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config\">Lifecycle and Versioning</a>.</p> </important> <p>The following operations are related to <code>PutBucketVersioning</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html\">DeleteBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a> </p> </li> </ul>", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":true @@ -1292,7 +1293,7 @@ {"shape":"EncryptionTypeMismatch"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html", - "documentation":"<p>Adds an object to a bucket.</p> <note> <ul> <li> <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. You cannot use <code>PutObject</code> to only update a single piece of metadata for an existing object. You must put the entire object with updated metadata if you want to update some values.</p> </li> <li> <p>If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All objects written to the bucket by any account will be owned by the bucket owner.</p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <p>Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:</p> <ul> <li> <p> <b>S3 Object Lock</b> - To prevent objects from being deleted or overwritten, you can use <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html\">Amazon S3 Object Lock</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note> </li> <li> <p> <b>S3 Versioning</b> - When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID of that object being stored in Amazon S3. You can retrieve, replace, or delete any version of the object. For more information about versioning, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html\">Adding Objects to Versioning-Enabled Buckets</a> in the <i>Amazon S3 User Guide</i>. For information about returning the versioning state of a bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a>. </p> <note> <p>This functionality is not supported for directory buckets.</p> </note> </li> </ul> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - The following permissions are required in your policies when your <code>PutObject</code> request includes specific headers.</p> <ul> <li> <p> <b> <code>s3:PutObject</code> </b> - To successfully complete the <code>PutObject</code> request, you must always have the <code>s3:PutObject</code> permission on a bucket to add an object to it.</p> </li> <li> <p> <b> <code>s3:PutObjectAcl</code> </b> - To successfully change the objects ACL of your <code>PutObject</code> request, you must have the <code>s3:PutObjectAcl</code>.</p> </li> <li> <p> <b> <code>s3:PutObjectTagging</code> </b> - To successfully set the tag-set with your <code>PutObject</code> request, you must have the <code>s3:PutObjectTagging</code>.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> </li> </ul> </dd> <dt>Data integrity with Content-MD5</dt> <dd> <ul> <li> <p> <b>General purpose bucket</b> - To ensure that data is not corrupted traversing the network, use the <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 value.</p> </li> <li> <p> <b>Directory bucket</b> - This functionality is not supported for directory buckets.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>For more information about related Amazon S3 APIs, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html\">DeleteObject</a> </p> </li> </ul>", + "documentation":"<p>Adds an object to a bucket.</p> <note> <ul> <li> <p>Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. You cannot use <code>PutObject</code> to only update a single piece of metadata for an existing object. You must put the entire object with updated metadata if you want to update some values.</p> </li> <li> <p>If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All objects written to the bucket by any account will be owned by the bucket owner.</p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </note> <p>Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:</p> <ul> <li> <p> <b>S3 Object Lock</b> - To prevent objects from being deleted or overwritten, you can use <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html\">Amazon S3 Object Lock</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note> </li> <li> <p> <b>If-None-Match</b> - Uploads the object only if the object key name does not already exist in the specified bucket. Otherwise, Amazon S3 returns a <code>412 Precondition Failed</code> error. If a conflicting operation occurs during the upload, S3 returns a <code>409 ConditionalRequestConflict</code> response. On a 409 failure, retry the upload.</p> <p>Expects the * character (asterisk).</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html\">Add preconditions to S3 operations with conditional requests</a> in the <i>Amazon S3 User Guide</i> or <a href=\"https://datatracker.ietf.org/doc/rfc7232/\">RFC 7232</a>. </p> <note> <p>This functionality is not supported for S3 on Outposts.</p> </note> </li> <li> <p> <b>S3 Versioning</b> - When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID of that object being stored in Amazon S3. You can retrieve, replace, or delete any version of the object. For more information about versioning, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html\">Adding Objects to Versioning-Enabled Buckets</a> in the <i>Amazon S3 User Guide</i>. For information about returning the versioning state of a bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html\">GetBucketVersioning</a>. </p> <note> <p>This functionality is not supported for directory buckets.</p> </note> </li> </ul> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - The following permissions are required in your policies when your <code>PutObject</code> request includes specific headers.</p> <ul> <li> <p> <b> <code>s3:PutObject</code> </b> - To successfully complete the <code>PutObject</code> request, you must always have the <code>s3:PutObject</code> permission on a bucket to add an object to it.</p> </li> <li> <p> <b> <code>s3:PutObjectAcl</code> </b> - To successfully change the objects ACL of your <code>PutObject</code> request, you must have the <code>s3:PutObjectAcl</code>.</p> </li> <li> <p> <b> <code>s3:PutObjectTagging</code> </b> - To successfully set the tag-set with your <code>PutObject</code> request, you must have the <code>s3:PutObjectTagging</code>.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> </li> </ul> </dd> <dt>Data integrity with Content-MD5</dt> <dd> <ul> <li> <p> <b>General purpose bucket</b> - To ensure that data is not corrupted traversing the network, use the <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 value.</p> </li> <li> <p> <b>Directory bucket</b> - This functionality is not supported for directory buckets.</p> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>For more information about related Amazon S3 APIs, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html\">DeleteObject</a> </p> </li> </ul>", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":false @@ -1445,7 +1446,7 @@ "input":{"shape":"UploadPartRequest"}, "output":{"shape":"UploadPartOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html", - "documentation":"<p>Uploads a part in a multipart upload.</p> <note> <p>In this operation, you provide new data as a part of an object in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a> operation. </p> </note> <p>You must initiate a multipart upload (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier that you must include in your upload part request.</p> <p>Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.</p> <p>For information about maximum and minimum part sizes and other multipart upload specifications, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html\">Multipart upload limits</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p> </note> <p>For more information on multipart uploads, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html\">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide </i>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey</code> actions on the key. The requester must also have permissions for the <code>kms:GenerateDataKey</code> action for the <code>CreateMultipartUpload</code> API. Then, the requester needs permissions for the <code>kms:Decrypt</code> action on the <code>UploadPart</code> and <code>UploadPartCopy</code> APIs.</p> <p>These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information about KMS permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html\">Protecting data using server-side encryption with KMS</a> in the <i>Amazon S3 User Guide</i>. For information about the permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart upload and permissions</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions\">Multipart upload API and permissions</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> </li> </ul> </dd> <dt>Data integrity</dt> <dd> <p> <b>General purpose bucket</b> - To ensure that data is not corrupted traversing the network, specify the <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the <code>x-amz-content-sha256</code> header as a checksum instead of <code>Content-MD5</code>. For more information see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html\">Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)</a>. </p> <note> <p> <b>Directory buckets</b> - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.</p> </note> </dd> <dt>Encryption</dt> <dd> <ul> <li> <p> <b>General purpose bucket</b> - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You have mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption with other key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or provide your own encryption key (SSE-C).</p> <p>Server-side encryption is supported by the S3 Multipart Upload operations. Unless you are using a customer-provided encryption key (SSE-C), you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>.</p> <p>If you request server-side encryption using a customer-provided encryption key (SSE-C) in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following request headers.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p> For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html\">Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory buckets </b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>).</p> </li> </ul> </dd> <dt>Special errors</dt> <dd> <ul> <li> <p>Error Code: <code>NoSuchUpload</code> </p> <ul> <li> <p>Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</p> </li> <li> <p>HTTP Status Code: 404 Not Found </p> </li> <li> <p>SOAP Fault Code Prefix: Client</p> </li> </ul> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>UploadPart</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>", + "documentation":"<p>Uploads a part in a multipart upload.</p> <note> <p>In this operation, you provide new data as a part of an object in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a> operation. </p> </note> <p>You must initiate a multipart upload (see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier that you must include in your upload part request.</p> <p>Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.</p> <p>For information about maximum and minimum part sizes and other multipart upload specifications, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html\">Multipart upload limits</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p> </note> <p>For more information on multipart uploads, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html\">Multipart Upload Overview</a> in the <i>Amazon S3 User Guide </i>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p> <b>General purpose bucket permissions</b> - To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey</code> actions on the key. The requester must also have permissions for the <code>kms:GenerateDataKey</code> action for the <code>CreateMultipartUpload</code> API. Then, the requester needs permissions for the <code>kms:Decrypt</code> action on the <code>UploadPart</code> and <code>UploadPartCopy</code> APIs.</p> <p>These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information about KMS permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html\">Protecting data using server-side encryption with KMS</a> in the <i>Amazon S3 User Guide</i>. For information about the permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart upload and permissions</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions\">Multipart upload API and permissions</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory bucket permissions</b> - To grant access to this API operation on a directory bucket, we recommend that you use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html\"> <code>CreateSession</code> </a>.</p> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> </li> </ul> </dd> <dt>Data integrity</dt> <dd> <p> <b>General purpose bucket</b> - To ensure that data is not corrupted traversing the network, specify the <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the <code>x-amz-content-sha256</code> header as a checksum instead of <code>Content-MD5</code>. For more information see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html\">Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)</a>. </p> <note> <p> <b>Directory buckets</b> - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.</p> </note> </dd> <dt>Encryption</dt> <dd> <ul> <li> <p> <b>General purpose bucket</b> - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You have mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption with other key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or provide your own encryption key (SSE-C).</p> <p>Server-side encryption is supported by the S3 Multipart Upload operations. Unless you are using a customer-provided encryption key (SSE-C), you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a>.</p> <p>If you request server-side encryption using a customer-provided encryption key (SSE-C) in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following request headers.</p> <ul> <li> <p>x-amz-server-side-encryption-customer-algorithm</p> </li> <li> <p>x-amz-server-side-encryption-customer-key</p> </li> <li> <p>x-amz-server-side-encryption-customer-key-MD5</p> </li> </ul> <p> For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html\">Using Server-Side Encryption</a> in the <i>Amazon S3 User Guide</i>.</p> </li> <li> <p> <b>Directory buckets </b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>).</p> </li> </ul> </dd> <dt>Special errors</dt> <dd> <ul> <li> <p>Error Code: <code>NoSuchUpload</code> </p> <ul> <li> <p>Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</p> </li> <li> <p>HTTP Status Code: 404 Not Found </p> </li> <li> <p>SOAP Fault Code Prefix: Client</p> </li> </ul> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>UploadPart</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>", "httpChecksum":{ "requestAlgorithmMember":"ChecksumAlgorithm", "requestChecksumRequired":false @@ -1460,7 +1461,7 @@ "input":{"shape":"UploadPartCopyRequest"}, "output":{"shape":"UploadPartCopyOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html", - "documentation":"<p>Uploads a part by copying data from an existing object as data source. To specify the data source, you add the request header <code>x-amz-copy-source</code> in your request. To specify a byte range, you add the request header <code>x-amz-copy-source-range</code> in your request. </p> <p>For information about maximum and minimum part sizes and other multipart upload specifications, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html\">Multipart upload limits</a> in the <i>Amazon S3 User Guide</i>. </p> <note> <p>Instead of copying data from an existing object as part data, you might use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> action to upload new data as a part of an object in your request.</p> </note> <p>You must initiate a multipart upload before you can upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in your upload part request.</p> <p>For conceptual information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>. For information about copying objects using a single atomic action vs. a multipart upload, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html\">Operations on Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Authentication and authorization</dt> <dd> <p>All <code>UploadPartCopy</code> requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a>.</p> <p> <b>Directory buckets</b> - You must use IAM credentials to authenticate and authorize your access to the <code>UploadPartCopy</code> API operation, instead of using the temporary security credentials through the <code>CreateSession</code> API operation.</p> <p>Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.</p> </dd> <dt>Permissions</dt> <dd> <p>You must have <code>READ</code> access to the source object and <code>WRITE</code> access to the destination bucket.</p> <ul> <li> <p> <b>General purpose bucket permissions</b> - You must have the permissions in a policy based on the bucket types of your source bucket and destination bucket in an <code>UploadPartCopy</code> operation.</p> <ul> <li> <p>If the source object is in a general purpose bucket, you must have the <b> <code>s3:GetObject</code> </b> permission to read the source object that is being copied. </p> </li> <li> <p>If the destination bucket is a general purpose bucket, you must have the <b> <code>s3:PutObject</code> </b> permission to write the object copy to the destination bucket. </p> </li> <li> <p>To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey</code> actions on the key. The requester must also have permissions for the <code>kms:GenerateDataKey</code> action for the <code>CreateMultipartUpload</code> API. Then, the requester needs permissions for the <code>kms:Decrypt</code> action on the <code>UploadPart</code> and <code>UploadPartCopy</code> APIs. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information about KMS permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html\">Protecting data using server-side encryption with KMS</a> in the <i>Amazon S3 User Guide</i>. For information about the permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart upload and permissions</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions\">Multipart upload API and permissions</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in an <code>UploadPartCopy</code> operation.</p> <ul> <li> <p>If the source object that you want to copy is in a directory bucket, you must have the <b> <code>s3express:CreateSession</code> </b> permission in the <code>Action</code> element of a policy to read the object. By default, the session is in the <code>ReadWrite</code> mode. If you want to restrict the access, you can explicitly set the <code>s3express:SessionMode</code> condition key to <code>ReadOnly</code> on the copy source bucket.</p> </li> <li> <p>If the copy destination is a directory bucket, you must have the <b> <code>s3express:CreateSession</code> </b> permission in the <code>Action</code> element of a policy to write the object to the destination. The <code>s3express:SessionMode</code> condition key cannot be set to <code>ReadOnly</code> on the copy destination. </p> </li> </ul> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> <p>For example policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html\">Example bucket policies for S3 Express One Zone</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html\">Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </dd> <dt>Encryption</dt> <dd> <ul> <li> <p> <b>General purpose buckets </b> - For information about using server-side encryption with customer-provided encryption keys with the <code>UploadPartCopy</code> operation, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a>. </p> </li> <li> <p> <b>Directory buckets </b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>For directory buckets, when you perform a <code>CreateMultipartUpload</code> operation and an <code>UploadPartCopy</code> operation, the request headers you provide in the <code>CreateMultipartUpload</code> request must match the default encryption configuration of the destination bucket. </p> </note> <p>S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p> </li> </ul> </dd> <dt>Special errors</dt> <dd> <ul> <li> <p>Error Code: <code>NoSuchUpload</code> </p> <ul> <li> <p>Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> </ul> </li> <li> <p>Error Code: <code>InvalidRequest</code> </p> <ul> <li> <p>Description: The specified copy source is not supported as a byte-range copy source.</p> </li> <li> <p>HTTP Status Code: 400 Bad Request</p> </li> </ul> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>UploadPartCopy</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>", + "documentation":"<p>Uploads a part by copying data from an existing object as data source. To specify the data source, you add the request header <code>x-amz-copy-source</code> in your request. To specify a byte range, you add the request header <code>x-amz-copy-source-range</code> in your request. </p> <p>For information about maximum and minimum part sizes and other multipart upload specifications, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html\">Multipart upload limits</a> in the <i>Amazon S3 User Guide</i>. </p> <note> <p>Instead of copying data from an existing object as part data, you might use the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> action to upload new data as a part of an object in your request.</p> </note> <p>You must initiate a multipart upload before you can upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in your upload part request.</p> <p>For conceptual information about multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html\">Uploading Objects Using Multipart Upload</a> in the <i>Amazon S3 User Guide</i>. For information about copying objects using a single atomic action vs. a multipart upload, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html\">Operations on Objects</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p> <b>Directory buckets</b> - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format <code>https://<i>amzn-s3-demo-bucket</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com/<i>key-name</i> </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html\">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html\">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p> </note> <dl> <dt>Authentication and authorization</dt> <dd> <p>All <code>UploadPartCopy</code> requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the <code>x-amz-</code> prefix, including <code>x-amz-copy-source</code>, must be signed. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a>.</p> <p> <b>Directory buckets</b> - You must use IAM credentials to authenticate and authorize your access to the <code>UploadPartCopy</code> API operation, instead of using the temporary security credentials through the <code>CreateSession</code> API operation.</p> <p>Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.</p> </dd> <dt>Permissions</dt> <dd> <p>You must have <code>READ</code> access to the source object and <code>WRITE</code> access to the destination bucket.</p> <ul> <li> <p> <b>General purpose bucket permissions</b> - You must have the permissions in a policy based on the bucket types of your source bucket and destination bucket in an <code>UploadPartCopy</code> operation.</p> <ul> <li> <p>If the source object is in a general purpose bucket, you must have the <b> <code>s3:GetObject</code> </b> permission to read the source object that is being copied. </p> </li> <li> <p>If the destination bucket is a general purpose bucket, you must have the <b> <code>s3:PutObject</code> </b> permission to write the object copy to the destination bucket. </p> </li> <li> <p>To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the <code>kms:Decrypt</code> and <code>kms:GenerateDataKey</code> actions on the key. The requester must also have permissions for the <code>kms:GenerateDataKey</code> action for the <code>CreateMultipartUpload</code> API. Then, the requester needs permissions for the <code>kms:Decrypt</code> action on the <code>UploadPart</code> and <code>UploadPartCopy</code> APIs. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information about KMS permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html\">Protecting data using server-side encryption with KMS</a> in the <i>Amazon S3 User Guide</i>. For information about the permissions required to use the multipart upload API, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html\">Multipart upload and permissions</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions\">Multipart upload API and permissions</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </li> <li> <p> <b>Directory bucket permissions</b> - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in an <code>UploadPartCopy</code> operation.</p> <ul> <li> <p>If the source object that you want to copy is in a directory bucket, you must have the <b> <code>s3express:CreateSession</code> </b> permission in the <code>Action</code> element of a policy to read the object. By default, the session is in the <code>ReadWrite</code> mode. If you want to restrict the access, you can explicitly set the <code>s3express:SessionMode</code> condition key to <code>ReadOnly</code> on the copy source bucket.</p> </li> <li> <p>If the copy destination is a directory bucket, you must have the <b> <code>s3express:CreateSession</code> </b> permission in the <code>Action</code> element of a policy to write the object to the destination. The <code>s3express:SessionMode</code> condition key cannot be set to <code>ReadOnly</code> on the copy destination. </p> </li> </ul> <p>If the object is encrypted with SSE-KMS, you must also have the <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM identity-based policies and KMS key policies for the KMS key.</p> <p>For example policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html\">Example bucket policies for S3 Express One Zone</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html\">Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p> </li> </ul> </dd> <dt>Encryption</dt> <dd> <ul> <li> <p> <b>General purpose buckets </b> - For information about using server-side encryption with customer-provided encryption keys with the <code>UploadPartCopy</code> operation, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html\">CopyObject</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a>. </p> </li> <li> <p> <b>Directory buckets </b> - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>For directory buckets, when you perform a <code>CreateMultipartUpload</code> operation and an <code>UploadPartCopy</code> operation, the request headers you provide in the <code>CreateMultipartUpload</code> request must match the default encryption configuration of the destination bucket. </p> </note> <p>S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html\">UploadPartCopy</a>. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.</p> </li> </ul> </dd> <dt>Special errors</dt> <dd> <ul> <li> <p>Error Code: <code>NoSuchUpload</code> </p> <ul> <li> <p>Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> </ul> </li> <li> <p>Error Code: <code>InvalidRequest</code> </p> <ul> <li> <p>Description: The specified copy source is not supported as a byte-range copy source.</p> </li> <li> <p>HTTP Status Code: 400 Bad Request</p> </li> </ul> </li> </ul> </dd> <dt>HTTP Host header syntax</dt> <dd> <p> <b>Directory buckets </b> - The HTTP Host header syntax is <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>.</p> </dd> </dl> <p>The following operations are related to <code>UploadPartCopy</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html\">CreateMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html\">UploadPart</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html\">CompleteMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html\">AbortMultipartUpload</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html\">ListParts</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html\">ListMultipartUploads</a> </p> </li> </ul>", "staticContextParams":{ "DisableS3ExpressSessionAuth":{"value":true} } @@ -1515,7 +1516,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name to which the upload was taking place. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name to which the upload was taking place. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -1823,17 +1824,22 @@ "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", + "ap-southeast-4", + "ap-southeast-5", "ca-central-1", "cn-north-1", "cn-northwest-1", "EU", "eu-central-1", + "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", + "il-central-1", + "me-central-1", "me-south-1", "sa-east-1", "us-east-2", @@ -2016,19 +2022,27 @@ "members":{ "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. This checksum is present if the object was uploaded with the <code>CRC64NVME</code> checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, <code>CRC64NVME</code>, to the uploaded object). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>The checksum type that is used to calculate the object’s checksum value. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" } }, "documentation":"<p>Contains all the possible checksum or digest values for an object.</p>" @@ -2039,7 +2053,8 @@ "CRC32", "CRC32C", "SHA1", - "SHA256" + "SHA256", + "CRC64NVME" ] }, "ChecksumAlgorithmList":{ @@ -2049,12 +2064,20 @@ }, "ChecksumCRC32":{"type":"string"}, "ChecksumCRC32C":{"type":"string"}, + "ChecksumCRC64NVME":{"type":"string"}, "ChecksumMode":{ "type":"string", "enum":["ENABLED"] }, "ChecksumSHA1":{"type":"string"}, "ChecksumSHA256":{"type":"string"}, + "ChecksumType":{ + "type":"string", + "enum":[ + "COMPOSITE", + "FULL_OBJECT" + ] + }, "CloudFunction":{"type":"string"}, "CloudFunctionConfiguration":{ "type":"structure", @@ -2125,19 +2148,27 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. The <code>CRC64NVME</code> checksum is always a full object checksum. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>. </p>" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum type that was specified during the <code>CreateMultipartUpload</code> request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>.</p>" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", @@ -2180,7 +2211,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>Name of the bucket to which the multipart upload was initiated.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>Name of the bucket to which the multipart upload was initiated.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -2206,28 +2237,46 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32c" }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. The <code>CRC64NVME</code> checksum is always a full object checksum. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>.</p>", + "location":"header", + "locationName":"x-amz-checksum-crc64nvme" + }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit <code>SHA1</code> digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit <code>SHA256</code> digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha256" }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. If the checksum type doesn’t match the checksum type that was specified for the object during the <code>CreateMultipartUpload</code> request, it’ll result in a <code>BadDigest</code> error. For more information, see Checking object integrity in the Amazon S3 User Guide. </p>", + "location":"header", + "locationName":"x-amz-checksum-type" + }, + "MpuObjectSize":{ + "shape":"MpuObjectSize", + "documentation":"<p> The expected total object size of the multipart upload request. If there’s a mismatch between the specified object size value and the actual object size value, it results in an <code>HTTP 400 InvalidRequest</code> error. </p>", + "location":"header", + "locationName":"x-amz-mp-object-size" + }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", @@ -2292,19 +2341,23 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>CRC32</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>CRC32C</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>CRC64NVME</code> checksum algorithm to the uploaded object). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 160-bit <code>SHA1</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>SHA1</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 256-bit <code>SHA256</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>SHA256</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "PartNumber":{ "shape":"PartNumber", @@ -2409,7 +2462,7 @@ }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"<p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.</p>", + "documentation":"<p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded UTF-8 string holding JSON with the encryption context key-value pairs.</p>", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, @@ -2443,7 +2496,7 @@ }, "Bucket":{ "shape":"BucketName", - "documentation":"<p>The name of the destination bucket.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP <code>400 Bad Request</code> error with the error code <code>InvalidRequest</code>.</p> </note> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The name of the destination bucket.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP <code>400 Bad Request</code> error with the error code <code>InvalidRequest</code>.</p> </note> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must use the Outpost bucket access point ARN or the access point alias for the destination bucket. You can only copy objects within the same Outpost bucket. It's not supported to copy objects across different Amazon Web Services Outposts, between buckets on the same Outposts, or between Outposts buckets and any other bucket types. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>S3 on Outposts guide</i>. When you use this action with S3 on Outposts through the REST API, you must direct requests to the S3 on Outposts hostname, in the format <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. The hostname isn't required when you use the Amazon Web Services CLI or SDKs. </p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -2608,7 +2661,7 @@ }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"<p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version\">Specifying the Signature Version in Request Authentication</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Directory buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code>, the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. If you want to specify the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP <code>400 Bad Request</code> error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket for the lifetime of the bucket. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. </p>", + "documentation":"<p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version\">Specifying the Signature Version in Request Authentication</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Directory buckets</b> - To encrypt data using SSE-KMS, it's recommended to specify the <code>x-amz-server-side-encryption</code> header to <code>aws:kms</code>. Then, the <code>x-amz-server-side-encryption-aws-kms-key-id</code> header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket's lifetime. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. Incorrect key specification results in an HTTP <code>400 Bad Request</code> error. </p>", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, @@ -2696,21 +2749,29 @@ "shape":"LastModified", "documentation":"<p>Creation date of the object.</p>" }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>The checksum type that is used to calculate the object’s checksum value. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32</code> checksum of the object. This checksum is only present if the object was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This will only be present if the object was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. This checksum is present if the object being copied was uploaded with the <code>CRC64NVME</code> checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, <code>CRC64NVME</code>, to the uploaded object). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This will only be present if the object was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This will only be present if the object was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" } }, "documentation":"<p>Container for all response elements.</p>" @@ -2728,19 +2789,23 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum of the part. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum of the part. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>CRC64NVME</code> checksum algorithm to the uploaded object). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit <code>SHA1</code> checksum of the part. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit <code>SHA256</code> checksum of the part. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" } }, "documentation":"<p>Container for all response elements.</p>" @@ -2766,7 +2831,7 @@ "members":{ "LocationConstraint":{ "shape":"BucketLocationConstraint", - "documentation":"<p>Specifies the Region where the bucket will be created. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region.</p> <p>If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default.</p> <p>For a list of the valid values for all of the Amazon Web Services Regions, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a>.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>" + "documentation":"<p>Specifies the Region where the bucket will be created. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region.</p> <p>If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default. Configurations using the value <code>EU</code> will create a bucket in <code>eu-west-1</code>.</p> <p>For a list of the valid values for all of the Amazon Web Services Regions, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a>.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>" }, "Location":{ "shape":"LocationInfo", @@ -2952,7 +3017,7 @@ }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"<p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.</p>", + "documentation":"<p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.</p>", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, @@ -2972,6 +3037,12 @@ "documentation":"<p>The algorithm that was used to create a checksum of the object.</p>", "location":"header", "locationName":"x-amz-checksum-algorithm" + }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p> Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>.</p>", + "location":"header", + "locationName":"x-amz-checksum-type" } } }, @@ -2990,7 +3061,7 @@ }, "Bucket":{ "shape":"BucketName", - "documentation":"<p>The name of the bucket where the multipart upload is initiated and where the object is uploaded.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The name of the bucket where the multipart upload is initiated and where the object is uploaded.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -3106,13 +3177,13 @@ }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"<p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.</p> <p> <b>General purpose buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code> or <code>aws:kms:dsse</code>, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify <code>x-amz-server-side-encryption:aws:kms</code> or <code>x-amz-server-side-encryption:aws:kms:dsse</code>, but do not provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code>) to protect the data.</p> <p> <b>Directory buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code>, the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. If you want to specify the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP <code>400 Bad Request</code> error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket for the lifetime of the bucket. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. </p>", + "documentation":"<p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.</p> <p> <b>General purpose buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code> or <code>aws:kms:dsse</code>, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify <code>x-amz-server-side-encryption:aws:kms</code> or <code>x-amz-server-side-encryption:aws:kms:dsse</code>, but do not provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code>) to protect the data.</p> <p> <b>Directory buckets</b> - To encrypt data using SSE-KMS, it's recommended to specify the <code>x-amz-server-side-encryption</code> header to <code>aws:kms</code>. Then, the <code>x-amz-server-side-encryption-aws-kms-key-id</code> header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket's lifetime. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. Incorrect key specification results in an HTTP <code>400 Bad Request</code> error. </p>", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"<p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.</p> <p> <b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. </p>", + "documentation":"<p>Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.</p> <p> <b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. </p>", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, @@ -3162,6 +3233,12 @@ "documentation":"<p>Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-algorithm" + }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>.</p>", + "location":"header", + "locationName":"x-amz-checksum-type" } } }, @@ -3183,7 +3260,7 @@ }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"<p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p>", + "documentation":"<p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p>", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, @@ -3219,19 +3296,19 @@ }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", - "documentation":"<p>The server-side encryption algorithm to use when you store objects in the directory bucket.</p> <p>For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). By default, Amazon S3 encrypts data with SSE-S3. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The server-side encryption algorithm to use when you store objects in the directory bucket.</p> <p>For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (<code>AES256</code>) and server-side encryption with KMS keys (SSE-KMS) (<code>aws:kms</code>). By default, Amazon S3 encrypts data with SSE-S3. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/serv-side-encryption.html\">Protecting data with server-side encryption</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-server-side-encryption" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"<p>If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code>, you must specify the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header with the ID (Key ID or Key ARN) of the KMS symmetric encryption customer managed key to use. Otherwise, you get an HTTP <code>400 Bad Request</code> error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Also, if the KMS key doesn't exist in the same account that't issuing the command, you must use the full Key ARN not the Key ID. </p> <p>Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket for the lifetime of the bucket. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. </p>", + "documentation":"<p>If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code>, you must specify the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header with the ID (Key ID or Key ARN) of the KMS symmetric encryption customer managed key to use. Otherwise, you get an HTTP <code>400 Bad Request</code> error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Also, if the KMS key doesn't exist in the same account that't issuing the command, you must use the full Key ARN not the Key ID. </p> <p>Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket's lifetime. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. </p>", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"<p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p> <p> <b>General purpose buckets</b> - This value must be explicitly added during <code>CopyObject</code> operations if you want an additional encryption context for your object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context\">Encryption context</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. </p>", + "documentation":"<p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p> <p> <b>General purpose buckets</b> - This value must be explicitly added during <code>CopyObject</code> operations if you want an additional encryption context for your object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context\">Encryption context</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. </p>", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, @@ -3599,7 +3676,7 @@ "members":{ "Owner":{ "shape":"Owner", - "documentation":"<p>The account that created the delete marker.></p>" + "documentation":"<p>The account that created the delete marker. </p>" }, "Key":{ "shape":"ObjectKey", @@ -3611,7 +3688,7 @@ }, "IsLatest":{ "shape":"IsLatest", - "documentation":"<p>Specifies whether the object is (true) or is not (false) the latest version of an object.</p>" + "documentation":"<p>Specifies whether the object is (true) or is not (false) the latest version of an object. </p>" }, "LastModified":{ "shape":"LastModified", @@ -3648,7 +3725,7 @@ "members":{ "DeleteMarker":{ "shape":"DeleteMarker", - "documentation":"<p>Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>", + "documentation":"<p>Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker. To learn more about delete markers, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html\">Working with delete markers</a>.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>", "location":"header", "locationName":"x-amz-delete-marker" }, @@ -3674,7 +3751,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name of the bucket containing the object. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name of the bucket containing the object. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -3717,7 +3794,7 @@ }, "IfMatch":{ "shape":"IfMatch", - "documentation":"<p>The <code>If-Match</code> header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a <code>412 Precondition Failed</code> error. If the ETag matches or if the object doesn't exist, the operation will return a <code>204 Success (No Content) response</code>.</p> <p>For more information about conditional requests, see <a href=\"https://docs.aws.amazon.com/https:/tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> <note> <p>This functionality is only supported for directory buckets.</p> </note>", + "documentation":"<p>The <code>If-Match</code> header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a <code>412 Precondition Failed</code> error. If the ETag matches or if the object doesn't exist, the operation will return a <code>204 Success (No Content) response</code>.</p> <p>For more information about conditional requests, see <a href=\"https://tools.ietf.org/html/rfc7232\">RFC 7232</a>.</p> <note> <p>This functionality is only supported for directory buckets.</p> </note>", "location":"header", "locationName":"If-Match" }, @@ -3755,7 +3832,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name containing the objects from which to remove the tags. </p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name containing the objects from which to remove the tags. </p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -3808,7 +3885,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name containing the objects to delete. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name containing the objects to delete. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -3844,7 +3921,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i> </code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p> <p>For the <code>x-amz-checksum-<i>algorithm</i> </code> header, replace <code> <i>algorithm</i> </code> with the supported algorithm from the following list: </p> <ul> <li> <p> <code>CRC32</code> </p> </li> <li> <p> <code>CRC32C</code> </p> </li> <li> <p> <code>SHA1</code> </p> </li> <li> <p> <code>SHA256</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i> </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter and uses the checksum algorithm that matches the provided value in <code>x-amz-checksum-<i>algorithm</i> </code>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i> </code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p> <p>For the <code>x-amz-checksum-<i>algorithm</i> </code> header, replace <code> <i>algorithm</i> </code> with the supported algorithm from the following list: </p> <ul> <li> <p> <code>CRC32</code> </p> </li> <li> <p> <code>CRC32C</code> </p> </li> <li> <p> <code>CRC64NVME</code> </p> </li> <li> <p> <code>SHA1</code> </p> </li> <li> <p> <code>SHA256</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i> </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 fails the request with a <code>BadDigest</code> error.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" } @@ -3883,7 +3960,7 @@ }, "DeleteMarker":{ "shape":"DeleteMarker", - "documentation":"<p>Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>" + "documentation":"<p>Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker. To learn more about delete markers, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html\">Working with delete markers</a>.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>" }, "DeleteMarkerVersionId":{ "shape":"DeleteMarkerVersionId", @@ -4424,7 +4501,7 @@ }, "TransitionDefaultMinimumObjectSize":{ "shape":"TransitionDefaultMinimumObjectSize", - "documentation":"<p>Indicates which default minimum object size behavior is applied to the lifecycle configuration.</p> <note> <p>This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.</p> </note> <ul> <li> <p> <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not transition to any storage class by default.</p> </li> <li> <p> <code>varies_by_storage_class</code> - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB. </p> </li> </ul> <p>To customize the minimum object size for any transition you can add a filter that specifies a custom <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in the body of your transition rule. Custom filters always take precedence over the default transition behavior.</p>", + "documentation":"<p>Indicates which default minimum object size behavior is applied to the lifecycle configuration.</p> <note> <p>This parameter applies to general purpose buckets only. It isn't supported for directory bucket lifecycle configurations.</p> </note> <ul> <li> <p> <code>all_storage_classes_128K</code> - Objects smaller than 128 KB will not transition to any storage class by default.</p> </li> <li> <p> <code>varies_by_storage_class</code> - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB. </p> </li> </ul> <p>To customize the minimum object size for any transition you can add a filter that specifies a custom <code>ObjectSizeGreaterThan</code> or <code>ObjectSizeLessThan</code> in the body of your transition rule. Custom filters always take precedence over the default transition behavior.</p>", "location":"header", "locationName":"x-amz-transition-default-minimum-object-size" } @@ -4483,7 +4560,7 @@ "members":{ "LocationConstraint":{ "shape":"BucketLocationConstraint", - "documentation":"<p>Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a>. Buckets in Region <code>us-east-1</code> have a LocationConstraint of <code>null</code>.</p>" + "documentation":"<p>Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region\">Regions and Endpoints</a>.</p> <p>Buckets in Region <code>us-east-1</code> have a LocationConstraint of <code>null</code>. Buckets with a LocationConstraint of <code>EU</code> reside in <code>eu-west-1</code>.</p>" } } }, @@ -4946,7 +5023,7 @@ "members":{ "DeleteMarker":{ "shape":"DeleteMarker", - "documentation":"<p>Specifies whether the object retrieved was (<code>true</code>) or was not (<code>false</code>) a delete marker. If <code>false</code>, this response header does not appear in the response.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>", + "documentation":"<p>Specifies whether the object retrieved was (<code>true</code>) or was not (<code>false</code>) a delete marker. If <code>false</code>, this response header does not appear in the response. To learn more about delete markers, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html\">Working with delete markers</a>.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>", "location":"header", "locationName":"x-amz-delete-marker" }, @@ -5031,7 +5108,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The name of the bucket that contains the object.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The name of the bucket that contains the object.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -5228,28 +5305,40 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32</code> checksum of the object. This checksum is only present if the object was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This will only be present if the object was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32c" }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>.</p>", + "location":"header", + "locationName":"x-amz-checksum-crc64nvme" + }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This will only be present if the object was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This will only be present if the object was uploaded with the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha256" }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in the <code>CreateMultipartUpload</code> request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "location":"header", + "locationName":"x-amz-checksum-type" + }, "MissingMeta":{ "shape":"MissingMeta", "documentation":"<p>This is set to the number of metadata entries not returned in the headers that are prefixed with <code>x-amz-meta-</code>. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>", @@ -5405,7 +5494,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name containing the object. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Object Lambda access points</b> - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-object-lambda.<i>Region</i>.amazonaws.com.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name containing the object. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Object Lambda access points</b> - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-object-lambda.<i>Region</i>.amazonaws.com.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -5526,7 +5615,7 @@ }, "ChecksumMode":{ "shape":"ChecksumMode", - "documentation":"<p>To retrieve the checksum, this mode must be enabled.</p> <p> <b>General purpose buckets</b> - In addition, if you enable checksum mode and the object is uploaded with a <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html\">checksum</a> and encrypted with an Key Management Service (KMS) key, you must have permission to use the <code>kms:Decrypt</code> action to retrieve the checksum.</p>", + "documentation":"<p>To retrieve the checksum, this mode must be enabled.</p>", "location":"header", "locationName":"x-amz-checksum-mode" } @@ -5611,7 +5700,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name containing the object for which to get the tagging information. </p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name containing the object for which to get the tagging information. </p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -5824,7 +5913,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Object Lambda access points</b> - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned. For more information about <code>InvalidAccessPointAliasError</code>, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList\">List of Error Codes</a>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Object Lambda access points</b> - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code <code>InvalidAccessPointAliasError</code> is returned. For more information about <code>InvalidAccessPointAliasError</code>, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList\">List of Error Codes</a>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -5884,28 +5973,40 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32c" }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>.</p>", + "location":"header", + "locationName":"x-amz-checksum-crc64nvme" + }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha256" }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in <code>CreateMultipartUpload</code> request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>.</p>", + "location":"header", + "locationName":"x-amz-checksum-type" + }, "ETag":{ "shape":"ETag", "documentation":"<p>An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>", @@ -5954,6 +6055,12 @@ "location":"header", "locationName":"Content-Type" }, + "ContentRange":{ + "shape":"ContentRange", + "documentation":"<p>The portion of the object returned in the response for a <code>GET</code> request.</p>", + "location":"header", + "locationName":"Content-Range" + }, "Expires":{ "shape":"Expires", "documentation":"<p>The date and time at which the object is no longer cacheable.</p>", @@ -6054,7 +6161,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The name of the bucket that contains the object.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The name of the bucket that contains the object.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -7066,7 +7173,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The name of the bucket to which the multipart upload was initiated. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The name of the bucket to which the multipart upload was initiated. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -7150,7 +7257,7 @@ }, "DeleteMarkers":{ "shape":"DeleteMarkers", - "documentation":"<p>Container for an object that is a delete marker.</p>", + "documentation":"<p>Container for an object that is a delete marker. To learn more about delete markers, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html\">Working with delete markers</a>.</p>", "locationName":"DeleteMarker" }, "Name":{ @@ -7306,7 +7413,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The name of the bucket containing the objects.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The name of the bucket containing the objects.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -7425,7 +7532,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -7614,6 +7721,10 @@ "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", "documentation":"<p>The algorithm that was used to create a checksum of the object.</p>" + }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in <code>CreateMultipartUpload</code> request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>.</p>" } } }, @@ -7627,7 +7738,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The name of the bucket to which the parts are being uploaded. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The name of the bucket to which the parts are being uploaded. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -7921,6 +8032,7 @@ "box":true }, "MissingMeta":{"type":"integer"}, + "MpuObjectSize":{"type":"long"}, "MultipartUpload":{ "type":"structure", "members":{ @@ -7951,6 +8063,10 @@ "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", "documentation":"<p>The algorithm that was used to create a checksum of the object.</p>" + }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>The checksum type that is used to calculate the object’s checksum value. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" } }, "documentation":"<p>Container for the <code>MultipartUpload</code> for the Amazon S3 object.</p>" @@ -8106,6 +8222,10 @@ "shape":"ChecksumAlgorithmList", "documentation":"<p>The algorithm that was used to create a checksum of the object.</p>" }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>The checksum type that is used to calculate the object’s checksum value. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, "Size":{ "shape":"Size", "documentation":"<p>Size in bytes of the object</p>" @@ -8351,19 +8471,23 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>CRC32</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>CRC32C</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>CRC64NVME</code> checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, <code>CRC64NVME</code>, to the uploaded object). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 160-bit <code>SHA1</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>SHA1</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 256-bit <code>SHA256</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>SHA256</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" } }, "documentation":"<p>A container for elements related to an individual part.</p>" @@ -8407,6 +8531,10 @@ "shape":"ChecksumAlgorithmList", "documentation":"<p>The algorithm that was used to create a checksum of the object.</p>" }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>The checksum type that is used to calculate the object’s checksum value. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, "Size":{ "shape":"Size", "documentation":"<p>Size in bytes of the object.</p>" @@ -8554,19 +8682,23 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32</code> checksum of the part. This checksum is present if the object was uploaded with the <code>CRC32</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the part. This checksum is present if the object was uploaded with the <code>CRC32C</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the part. This checksum is present if the multipart upload request was created with the <code>CRC64NVME</code> checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, <code>CRC64NVME</code>, to the uploaded object). For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 160-bit <code>SHA1</code> checksum of the part. This checksum is present if the object was uploaded with the <code>SHA1</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" + "documentation":"<p>The Base64 encoded, 256-bit <code>SHA256</code> checksum of the part. This checksum is present if the object was uploaded with the <code>SHA256</code> checksum algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>" } }, "documentation":"<p>Container for elements related to a part.</p>" @@ -8730,7 +8862,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" } @@ -8762,13 +8894,13 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864.</a> </p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", + "documentation":"<p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864.</a> </p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", "location":"header", "locationName":"Content-MD5" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8869,13 +9001,13 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864.</a> </p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", + "documentation":"<p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864.</a> </p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", "location":"header", "locationName":"Content-MD5" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -8904,13 +9036,13 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>", + "documentation":"<p>The Base64 encoded 128-bit <code>MD5</code> digest of the server-side encryption configuration.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>", "location":"header", "locationName":"Content-MD5" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p> <note> <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p> </note>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p> <note> <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p> </note>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9018,7 +9150,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9062,7 +9194,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9109,7 +9241,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9214,7 +9346,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9290,7 +9422,7 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i> </code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p> <p>For the <code>x-amz-checksum-<i>algorithm</i> </code> header, replace <code> <i>algorithm</i> </code> with the supported algorithm from the following list: </p> <ul> <li> <p> <code>CRC32</code> </p> </li> <li> <p> <code>CRC32C</code> </p> </li> <li> <p> <code>SHA1</code> </p> </li> <li> <p> <code>SHA256</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i> </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter and uses the checksum algorithm that matches the provided value in <code>x-amz-checksum-<i>algorithm</i> </code>.</p> <note> <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p> </note>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i> </code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p> <p>For the <code>x-amz-checksum-<i>algorithm</i> </code> header, replace <code> <i>algorithm</i> </code> with the supported algorithm from the following list: </p> <ul> <li> <p> <code>CRC32</code> </p> </li> <li> <p> <code>CRC32C</code> </p> </li> <li> <p> <code>CRC64NVME</code> </p> </li> <li> <p> <code>SHA1</code> </p> </li> <li> <p> <code>SHA256</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i> </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 fails the request with a <code>BadDigest</code> error.</p> <note> <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p> </note>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9329,13 +9461,13 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", + "documentation":"<p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", "location":"header", "locationName":"Content-MD5" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9375,13 +9507,13 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", + "documentation":"<p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", "location":"header", "locationName":"Content-MD5" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9416,13 +9548,13 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", + "documentation":"<p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", "location":"header", "locationName":"Content-MD5" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9457,13 +9589,13 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", + "documentation":"<p>>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", "location":"header", "locationName":"Content-MD5" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9504,13 +9636,13 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", + "documentation":"<p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864</a>.</p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", "location":"header", "locationName":"Content-MD5" }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum</code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If you provide an individual checksum, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, @@ -9560,14 +9692,14 @@ }, "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name that contains the object to which you want to attach the ACL. </p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name that contains the object to which you want to attach the ACL. </p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864.></a> </p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", + "documentation":"<p>The Base64 encoded 128-bit <code>MD5</code> digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to <a href=\"http://www.ietf.org/rfc/rfc1864.txt\">RFC 1864.></a> </p> <p>For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.</p>", "location":"header", "locationName":"Content-MD5" }, @@ -9778,28 +9910,40 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32c" }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>The Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. This header is present if the object was uploaded with the <code>CRC64NVME</code> checksum algorithm, or if it was uploaded without a checksum (and Amazon S3 added the default checksum, <code>CRC64NVME</code>, to the uploaded object). For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>.</p>", + "location":"header", + "locationName":"x-amz-checksum-crc64nvme" + }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha256" }, + "ChecksumType":{ + "shape":"ChecksumType", + "documentation":"<p>This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For <code>PutObject</code> uploads, the checksum type is always <code>FULL_OBJECT</code>. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "location":"header", + "locationName":"x-amz-checksum-type" + }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"<p>The server-side encryption algorithm used when you store this object in Amazon S3.</p>", @@ -9832,7 +9976,7 @@ }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"<p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p>", + "documentation":"<p>If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p>", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, @@ -9844,7 +9988,7 @@ }, "Size":{ "shape":"Size", - "documentation":"<p> The size of the object in bytes. This will only be present if you append to an object. </p> <note> <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p> </note>", + "documentation":"<p> The size of the object in bytes. This value is only be present if you append to an object. </p> <note> <p>This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.</p> </note>", "location":"header", "locationName":"x-amz-object-size" }, @@ -9875,7 +10019,7 @@ }, "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name to which the PUT action was initiated. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name to which the PUT action was initiated. </p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -9912,7 +10056,7 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a>.</p> <note> <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object\">Uploading objects to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p> </note> <note> <p>This functionality is not supported for directory buckets.</p> </note>", + "documentation":"<p>The Base64 encoded 128-bit <code>MD5</code> digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">REST Authentication</a>.</p> <note> <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object\">Uploading objects to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p> </note> <note> <p>This functionality is not supported for directory buckets.</p> </note>", "location":"header", "locationName":"Content-MD5" }, @@ -9924,31 +10068,37 @@ }, "ChecksumAlgorithm":{ "shape":"ChecksumAlgorithm", - "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i> </code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p> <p>For the <code>x-amz-checksum-<i>algorithm</i> </code> header, replace <code> <i>algorithm</i> </code> with the supported algorithm from the following list: </p> <ul> <li> <p> <code>CRC32</code> </p> </li> <li> <p> <code>CRC32C</code> </p> </li> <li> <p> <code>SHA1</code> </p> </li> <li> <p> <code>SHA256</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i> </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 ignores any provided <code>ChecksumAlgorithm</code> parameter and uses the checksum algorithm that matches the provided value in <code>x-amz-checksum-<i>algorithm</i> </code>.</p> <note> <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object\">Uploading objects to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>", + "documentation":"<p>Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding <code>x-amz-checksum-<i>algorithm</i> </code> or <code>x-amz-trailer</code> header sent. Otherwise, Amazon S3 fails the request with the HTTP status code <code>400 Bad Request</code>.</p> <p>For the <code>x-amz-checksum-<i>algorithm</i> </code> header, replace <code> <i>algorithm</i> </code> with the supported algorithm from the following list: </p> <ul> <li> <p> <code>CRC32</code> </p> </li> <li> <p> <code>CRC32C</code> </p> </li> <li> <p> <code>CRC64NVME</code> </p> </li> <li> <p> <code>SHA1</code> </p> </li> <li> <p> <code>SHA256</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>If the individual checksum value you provide through <code>x-amz-checksum-<i>algorithm</i> </code> doesn't match the checksum algorithm you set through <code>x-amz-sdk-checksum-algorithm</code>, Amazon S3 fails the request with a <code>BadDigest</code> error.</p> <note> <p>The <code>Content-MD5</code> or <code>x-amz-sdk-checksum-algorithm</code> header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object\">Uploading objects to an Object Lock enabled bucket </a> in the <i>Amazon S3 User Guide</i>.</p> </note> <p>For directory buckets, when you use Amazon Web Services SDKs, <code>CRC32</code> is the default checksum algorithm that's used for performance.</p>", "location":"header", "locationName":"x-amz-sdk-checksum-algorithm" }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32c" }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the object. The <code>CRC64NVME</code> checksum is always a full object checksum. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity in the Amazon S3 User Guide</a>.</p>", + "location":"header", + "locationName":"x-amz-checksum-crc64nvme" + }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit <code>SHA1</code> digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit <code>SHA256</code> digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha256" }, @@ -10051,13 +10201,13 @@ }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", - "documentation":"<p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.</p> <p> <b>General purpose buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code> or <code>aws:kms:dsse</code>, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify <code>x-amz-server-side-encryption:aws:kms</code> or <code>x-amz-server-side-encryption:aws:kms:dsse</code>, but do not provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code>) to protect the data.</p> <p> <b>Directory buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code>, the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. If you want to specify the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP <code>400 Bad Request</code> error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket for the lifetime of the bucket. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. </p>", + "documentation":"<p>Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.</p> <p> <b>General purpose buckets</b> - If you specify <code>x-amz-server-side-encryption</code> with <code>aws:kms</code> or <code>aws:kms:dsse</code>, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify <code>x-amz-server-side-encryption:aws:kms</code> or <code>x-amz-server-side-encryption:aws:kms:dsse</code>, but do not provide <code>x-amz-server-side-encryption-aws-kms-key-id</code>, Amazon S3 uses the Amazon Web Services managed key (<code>aws/s3</code>) to protect the data.</p> <p> <b>Directory buckets</b> - To encrypt data using SSE-KMS, it's recommended to specify the <code>x-amz-server-side-encryption</code> header to <code>aws:kms</code>. Then, the <code>x-amz-server-side-encryption-aws-kms-key-id</code> header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the <code> x-amz-server-side-encryption-aws-kms-key-id</code> header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket's lifetime. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. Incorrect key specification results in an HTTP <code>400 Bad Request</code> error. </p>", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "SSEKMSEncryptionContext":{ "shape":"SSEKMSEncryptionContext", - "documentation":"<p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p> <p> <b>General purpose buckets</b> - This value must be explicitly added during <code>CopyObject</code> operations if you want an additional encryption context for your object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context\">Encryption context</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. </p>", + "documentation":"<p>Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future <code>GetObject</code> operations on this object.</p> <p> <b>General purpose buckets</b> - This value must be explicitly added during <code>CopyObject</code> operations if you want an additional encryption context for your object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context\">Encryption context</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Directory buckets</b> - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. </p>", "location":"header", "locationName":"x-amz-server-side-encryption-context" }, @@ -10270,7 +10420,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name containing the object. </p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name containing the object. </p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -10722,7 +10872,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name containing the object to restore. </p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name containing the object to restore. </p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -11185,7 +11335,7 @@ "documentation":"<p>Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the default encryption. </p> <note> <ul> <li> <p> <b>General purpose buckets</b> - This parameter is allowed if and only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code> or <code>aws:kms:dsse</code>.</p> </li> <li> <p> <b>Directory buckets</b> - This parameter is allowed if and only if <code>SSEAlgorithm</code> is set to <code>aws:kms</code>.</p> </li> </ul> </note> <p>You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key Alias: <code>alias/alias-name</code> </p> </li> </ul> <p>If you are using encryption with cross-account or Amazon Web Services service operations, you must use a fully qualified KMS key ARN. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy\">Using encryption for cross-account operations</a>.</p> <note> <ul> <li> <p> <b>General purpose buckets</b> - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. </p> </li> <li> <p> <b>Directory buckets</b> - When you specify an <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">KMS customer managed key</a> for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.</p> </li> </ul> </note> <important> <p>Amazon S3 only supports symmetric encryption KMS keys. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Asymmetric keys in Amazon Web Services KMS</a> in the <i>Amazon Web Services Key Management Service Developer Guide</i>.</p> </important>" } }, - "documentation":"<p>Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html\">PutBucketEncryption</a>.</p> <note> <ul> <li> <p> <b>General purpose buckets</b> - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key (<code>aws/s3</code>) in your Amazon Web Services account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. </p> </li> <li> <p> <b>Directory buckets</b> - Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket for the lifetime of the bucket. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. </p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.</p> </li> </ul> </note>" + "documentation":"<p>Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html\">PutBucketEncryption</a>.</p> <note> <ul> <li> <p> <b>General purpose buckets</b> - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key (<code>aws/s3</code>) in your Amazon Web Services account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. </p> </li> <li> <p> <b>Directory buckets</b> - Your SSE-KMS configuration can only support 1 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk\">customer managed key</a> per directory bucket's lifetime. The <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk\">Amazon Web Services managed key</a> (<code>aws/s3</code>) isn't supported. </p> </li> <li> <p> <b>Directory buckets</b> - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.</p> </li> </ul> </note>" }, "ServerSideEncryptionConfiguration":{ "type":"structure", @@ -11582,7 +11732,7 @@ }, "Days":{ "shape":"Days", - "documentation":"<p>Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.</p>" + "documentation":"<p>Indicates the number of days after creation when objects are transitioned to the specified storage class. If the specified storage class is <code>INTELLIGENT_TIERING</code>, <code>GLACIER_IR</code>, <code>GLACIER</code>, or <code>DEEP_ARCHIVE</code>, valid values are <code>0</code> or positive integers. If the specified storage class is <code>STANDARD_IA</code> or <code>ONEZONE_IA</code>, valid values are positive integers greater than <code>30</code>. Be aware that some storage classes have a minimum storage duration and that you're charged for transitioning objects before their minimum storage duration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-transition-general-considerations.html#lifecycle-configuration-constraints\"> Constraints and considerations for transitions</a> in the <i>Amazon S3 User Guide</i>.</p>" }, "StorageClass":{ "shape":"TransitionStorageClass", @@ -11687,7 +11837,7 @@ "members":{ "Bucket":{ "shape":"BucketName", - "documentation":"<p>The bucket name.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP <code>400 Bad Request</code> error with the error code <code>InvalidRequest</code>.</p> </note> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The bucket name.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP <code>400 Bad Request</code> error with the error code <code>InvalidRequest</code>.</p> </note> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -11818,25 +11968,31 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32 checksum</code> of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32c" }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the part. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "location":"header", + "locationName":"x-amz-checksum-crc64nvme" + }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 160-bit <code>SHA1</code> digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The Base64 encoded, 256-bit <code>SHA256</code> digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums\"> Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha256" }, @@ -11887,7 +12043,7 @@ }, "Bucket":{ "shape":"BucketName", - "documentation":"<p>The name of the bucket to which the multipart upload was initiated.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>The name of the bucket to which the multipart upload was initiated.</p> <p> <b>Directory buckets</b> - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format <code> <i>Bucket-name</i>.s3express-<i>zone-id</i>.<i>region-code</i>.amazonaws.com</code>. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>amzn-s3-demo-bucket</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html\">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i>.</p> <p> <b>Access points</b> - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html\">Using access points</a> in the <i>Amazon S3 User Guide</i>.</p> <note> <p>Access points and Object Lambda access points are not supported by directory buckets.</p> </note> <p> <b>S3 on Outposts</b> - When you use this action with S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form <code> <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. When you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">What is S3 on Outposts?</a> in the <i>Amazon S3 User Guide</i>.</p>", "contextParam":{"name":"Bucket"}, "location":"uri", "locationName":"Bucket" @@ -11900,7 +12056,7 @@ }, "ContentMD5":{ "shape":"ContentMD5", - "documentation":"<p>The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>", + "documentation":"<p>The Base64 encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>", "location":"header", "locationName":"Content-MD5" }, @@ -11912,25 +12068,31 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-crc32c" }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the part. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "location":"header", + "locationName":"x-amz-checksum-crc64nvme" + }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit <code>SHA1</code> digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit <code>SHA256</code> digest of the object. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", "location":"header", "locationName":"x-amz-checksum-sha256" }, @@ -12129,31 +12291,37 @@ }, "ChecksumCRC32":{ "shape":"ChecksumCRC32", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p> <p/>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 32-bit <code>CRC32</code> checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p> <p/>", "location":"header", "locationName":"x-amz-fwd-header-x-amz-checksum-crc32" }, "ChecksumCRC32C":{ "shape":"ChecksumCRC32C", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 32-bit <code>CRC32C</code> checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>", "location":"header", "locationName":"x-amz-fwd-header-x-amz-checksum-crc32c" }, + "ChecksumCRC64NVME":{ + "shape":"ChecksumCRC64NVME", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit <code>CRC64NVME</code> checksum of the part. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p>", + "location":"header", + "locationName":"x-amz-fwd-header-x-amz-checksum-crc64nvme" + }, "ChecksumSHA1":{ "shape":"ChecksumSHA1", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 160-bit <code>SHA1</code> digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>", "location":"header", "locationName":"x-amz-fwd-header-x-amz-checksum-sha1" }, "ChecksumSHA256":{ "shape":"ChecksumSHA256", - "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>", + "documentation":"<p>This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 256-bit <code>SHA256</code> digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original <code>GetObject</code> request required checksum validation. For more information about checksums, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html\">Checking object integrity</a> in the <i>Amazon S3 User Guide</i>.</p> <p>Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.</p>", "location":"header", "locationName":"x-amz-fwd-header-x-amz-checksum-sha256" }, "DeleteMarker":{ "shape":"DeleteMarker", - "documentation":"<p>Specifies whether an object stored in Amazon S3 is (<code>true</code>) or is not (<code>false</code>) a delete marker. </p>", + "documentation":"<p>Specifies whether an object stored in Amazon S3 is (<code>true</code>) or is not (<code>false</code>) a delete marker. To learn more about delete markers, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html\">Working with delete markers</a>.</p>", "location":"header", "locationName":"x-amz-fwd-header-x-amz-delete-marker" }, diff --git a/contrib/python/botocore/py3/botocore/data/s3control/2018-08-20/service-2.json b/contrib/python/botocore/py3/botocore/data/s3control/2018-08-20/service-2.json index f7f41266127..a234cfc2990 100644 --- a/contrib/python/botocore/py3/botocore/data/s3control/2018-08-20/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/s3control/2018-08-20/service-2.json @@ -3380,7 +3380,7 @@ "type":"string", "max":1024, "min":1, - "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" }, "GeneratedManifestEncryption":{ "type":"structure", @@ -5102,7 +5102,7 @@ }, "ExpiredObjectDeleteMarker":{ "shape":"ExpiredObjectDeleteMarker", - "documentation":"<p>Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired. If set to false, the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.</p>" + "documentation":"<p>Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired. If set to false, the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy. To learn more about delete markers, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html\">Working with delete markers</a>.</p>" } }, "documentation":"<p>The container of the Outposts bucket lifecycle expiration.</p>" @@ -7408,7 +7408,7 @@ "members":{ "TargetResource":{ "shape":"S3RegionalOrS3ExpressBucketArnString", - "documentation":"<p>Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.</p> <ul> <li> <p> <b>General purpose buckets</b> - For example, to copy objects to a general purpose bucket named <code>destinationBucket</code>, set the <code>TargetResource</code> property to <code>arn:aws:s3:::destinationBucket</code>.</p> </li> <li> <p> <b>Directory buckets</b> - For example, to copy objects to a directory bucket named <code>destinationBucket</code> in the Availability Zone; identified by the AZ ID <code>usw2-az1</code>, set the <code>TargetResource</code> property to <code>arn:aws:s3express:<i>region</i>:<i>account_id</i>:/bucket/<i>destination_bucket_base_name</i>--<i>usw2-az1</i>--x-s3</code>.</p> </li> </ul>" + "documentation":"<p>Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.</p> <ul> <li> <p> <b>General purpose buckets</b> - For example, to copy objects to a general purpose bucket named <code>destinationBucket</code>, set the <code>TargetResource</code> property to <code>arn:aws:s3:::destinationBucket</code>.</p> </li> <li> <p> <b>Directory buckets</b> - For example, to copy objects to a directory bucket named <code>destinationBucket</code> in the Availability Zone identified by the AZ ID <code>usw2-az1</code>, set the <code>TargetResource</code> property to <code>arn:aws:s3express:<i>region</i>:<i>account_id</i>:/bucket/<i>destination_bucket_base_name</i>--<i>usw2-az1</i>--x-s3</code>. A directory bucket as a destination bucket can be in Availability Zone or Local Zone. </p> <note> <p>Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP <code>400 Bad Request</code> error with the error code <code>InvalidRequest</code>.</p> </note> </li> </ul>" }, "CannedAccessControlList":{ "shape":"S3CannedAccessControlList", diff --git a/contrib/python/botocore/py3/botocore/data/s3tables/2018-05-10/service-2.json b/contrib/python/botocore/py3/botocore/data/s3tables/2018-05-10/service-2.json index 441889a7dd6..fb894ec07fe 100644 --- a/contrib/python/botocore/py3/botocore/data/s3tables/2018-05-10/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/s3tables/2018-05-10/service-2.json @@ -30,7 +30,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Creates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace.html\">Table namespaces</a>. </p>" + "documentation":"<p>Creates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace-create.html\">Create a namespace</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:CreateNamespace</code> permission to use this operation. </p> </dd> </dl>" }, "CreateTable":{ "name":"CreateTable", @@ -49,7 +49,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Creates a new table associated with the given namespace in a table bucket.</p>" + "documentation":"<p>Creates a new table associated with the given namespace in a table bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-create.html\">Creating an Amazon S3 table</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:CreateTable</code> permission to use this operation. </p> <note> <p>Additionally, you must have the <code>s3tables:PutTableData</code> permission to use this operation with the optional <code>metadata</code> request parameter. </p> </note> </dd> </dl>" }, "CreateTableBucket":{ "name":"CreateTableBucket", @@ -68,7 +68,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Creates a table bucket.</p>" + "documentation":"<p>Creates a table bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-create.html\">Creating a table bucket</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:CreateTableBucket</code> permission to use this operation. </p> </dd> </dl>" }, "DeleteNamespace":{ "name":"DeleteNamespace", @@ -86,7 +86,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Deletes a namespace.</p>", + "documentation":"<p>Deletes a namespace. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace-delete.html\">Delete a namespace</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteNamespace</code> permission to use this operation. </p> </dd> </dl>", "idempotent":true }, "DeleteTable":{ @@ -105,7 +105,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Deletes a table.</p>", + "documentation":"<p>Deletes a table. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-delete.html\">Deleting an Amazon S3 table</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteTable</code> permission to use this operation. </p> </dd> </dl>", "idempotent":true }, "DeleteTableBucket":{ @@ -124,7 +124,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Deletes a table bucket.</p>", + "documentation":"<p>Deletes a table bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-delete.html\">Deleting a table bucket</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteTableBucket</code> permission to use this operation. </p> </dd> </dl>", "idempotent":true }, "DeleteTableBucketPolicy":{ @@ -143,7 +143,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Deletes a table bucket policy.</p>", + "documentation":"<p>Deletes a table bucket policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-delete\">Deleting a table bucket policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteTableBucketPolicy</code> permission to use this operation. </p> </dd> </dl>", "idempotent":true }, "DeleteTablePolicy":{ @@ -162,7 +162,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Deletes a table policy.</p>", + "documentation":"<p>Deletes a table policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-delete\">Deleting a table policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteTablePolicy</code> permission to use this operation. </p> </dd> </dl>", "idempotent":true }, "GetNamespace":{ @@ -183,7 +183,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Gets details about a namespace.</p>" + "documentation":"<p>Gets details about a namespace. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace.html\">Table namespaces</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetNamespace</code> permission to use this operation. </p> </dd> </dl>" }, "GetTable":{ "name":"GetTable", @@ -203,7 +203,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Gets details about a table.</p>" + "documentation":"<p>Gets details about a table. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-tables.html\">S3 Tables</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTable</code> permission to use this operation. </p> </dd> </dl>" }, "GetTableBucket":{ "name":"GetTableBucket", @@ -223,7 +223,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Gets details on a table bucket.</p>" + "documentation":"<p>Gets details on a table bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-details.html\">Viewing details about an Amazon S3 table bucket</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTableBucket</code> permission to use this operation. </p> </dd> </dl>" }, "GetTableBucketMaintenanceConfiguration":{ "name":"GetTableBucketMaintenanceConfiguration", @@ -242,7 +242,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Gets details about a maintenance configuration for a given table bucket.</p>" + "documentation":"<p>Gets details about a maintenance configuration for a given table bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html\">Amazon S3 table bucket maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTableBucketMaintenanceConfiguration</code> permission to use this operation. </p> </dd> </dl>" }, "GetTableBucketPolicy":{ "name":"GetTableBucketPolicy", @@ -261,7 +261,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Gets details about a table bucket policy.</p>" + "documentation":"<p>Gets details about a table bucket policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-get\">Viewing a table bucket policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTableBucketPolicy</code> permission to use this operation. </p> </dd> </dl>" }, "GetTableMaintenanceConfiguration":{ "name":"GetTableMaintenanceConfiguration", @@ -280,7 +280,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Gets details about the maintenance configuration of a table.</p>" + "documentation":"<p>Gets details about the maintenance configuration of a table. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html\">S3 Tables maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTableMaintenanceConfiguration</code> permission to use this operation. </p> </dd> </dl>" }, "GetTableMaintenanceJobStatus":{ "name":"GetTableMaintenanceJobStatus", @@ -299,7 +299,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Gets the status of a maintenance job for a table.</p>" + "documentation":"<p>Gets the status of a maintenance job for a table. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html\">S3 Tables maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTableMaintenanceJobStatus</code> permission to use this operation. </p> </dd> </dl>" }, "GetTableMetadataLocation":{ "name":"GetTableMetadataLocation", @@ -318,7 +318,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Gets the location of the table metadata.</p>" + "documentation":"<p>Gets the location of the table metadata.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTableMetadataLocation</code> permission to use this operation. </p> </dd> </dl>" }, "GetTablePolicy":{ "name":"GetTablePolicy", @@ -337,7 +337,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Gets details about a table policy.</p>" + "documentation":"<p>Gets details about a table policy. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-get\">Viewing a table policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetTablePolicy</code> permission to use this operation. </p> </dd> </dl>" }, "ListNamespaces":{ "name":"ListNamespaces", @@ -357,7 +357,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Lists the namespaces within a table bucket.</p>" + "documentation":"<p>Lists the namespaces within a table bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace.html\">Table namespaces</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:ListNamespaces</code> permission to use this operation. </p> </dd> </dl>" }, "ListTableBuckets":{ "name":"ListTableBuckets", @@ -377,7 +377,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Lists table buckets for your account.</p>" + "documentation":"<p>Lists table buckets for your account. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets.html\">S3 Table buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:ListTableBuckets</code> permission to use this operation. </p> </dd> </dl>" }, "ListTables":{ "name":"ListTables", @@ -396,7 +396,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>List tables in the given table bucket.</p>" + "documentation":"<p>List tables in the given table bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-tables.html\">S3 Tables</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:ListTables</code> permission to use this operation. </p> </dd> </dl>" }, "PutTableBucketMaintenanceConfiguration":{ "name":"PutTableBucketMaintenanceConfiguration", @@ -414,7 +414,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket.</p>" + "documentation":"<p>Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html\">Amazon S3 table bucket maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:PutTableBucketMaintenanceConfiguration</code> permission to use this operation. </p> </dd> </dl>" }, "PutTableBucketPolicy":{ "name":"PutTableBucketPolicy", @@ -432,7 +432,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Creates a new maintenance configuration or replaces an existing table bucket policy for a table bucket. </p>", + "documentation":"<p>Creates a new maintenance configuration or replaces an existing table bucket policy for a table bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-add\">Adding a table bucket policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:PutTableBucketPolicy</code> permission to use this operation. </p> </dd> </dl>", "idempotent":true }, "PutTableMaintenanceConfiguration":{ @@ -451,7 +451,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Creates a new maintenance configuration or replaces an existing maintenance configuration for a table.</p>" + "documentation":"<p>Creates a new maintenance configuration or replaces an existing maintenance configuration for a table. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html\">S3 Tables maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:PutTableMaintenanceConfiguration</code> permission to use this operation. </p> </dd> </dl>" }, "PutTablePolicy":{ "name":"PutTablePolicy", @@ -469,7 +469,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Creates a new maintenance configuration or replaces an existing table policy for a table. </p>", + "documentation":"<p>Creates a new maintenance configuration or replaces an existing table policy for a table. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-add\">Adding a table policy</a> in the <i>Amazon Simple Storage Service User Guide</i>. </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:PutTablePolicy</code> permission to use this operation. </p> </dd> </dl>", "idempotent":true }, "RenameTable":{ @@ -488,7 +488,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Renames a table or a namespace.</p>" + "documentation":"<p>Renames a table or a namespace. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-tables.html\">S3 Tables</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:RenameTable</code> permission to use this operation. </p> </dd> </dl>" }, "UpdateTableMetadataLocation":{ "name":"UpdateTableMetadataLocation", @@ -507,7 +507,7 @@ {"shape":"ConflictException"}, {"shape":"BadRequestException"} ], - "documentation":"<p>Updates the metadata location for a table.</p>" + "documentation":"<p>Updates the metadata location for a table. The metadata location of a table must be an S3 URI that begins with the table's warehouse location. The metadata location for an Apache Iceberg table must end with <code>.metadata.json</code>, or if the metadata file is Gzip-compressed, <code>.metadata.json.gz</code>.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:UpdateTableMetadataLocation</code> permission to use this operation. </p> </dd> </dl>" } }, "shapes":{ @@ -541,6 +541,10 @@ }, "exception":true }, + "Boolean":{ + "type":"boolean", + "box":true + }, "ConflictException":{ "type":"structure", "members":{ @@ -643,6 +647,10 @@ "format":{ "shape":"OpenTableFormat", "documentation":"<p>The format for the table.</p>" + }, + "metadata":{ + "shape":"TableMetadata", + "documentation":"<p>The metadata for the table.</p>" } } }, @@ -690,7 +698,7 @@ "members":{ "tableBucketARN":{ "shape":"TableBucketARN", - "documentation":"<p>The Amazon Resource Number (ARN) of the table bucket.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the table bucket.</p>", "location":"uri", "locationName":"tableBucketARN" } @@ -718,7 +726,7 @@ "members":{ "tableBucketARN":{ "shape":"TableBucketARN", - "documentation":"<p>The Amazon Resource Number (ARN) of the table bucket that contains the table.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the table bucket that contains the table.</p>", "location":"uri", "locationName":"tableBucketARN" }, @@ -866,7 +874,7 @@ "members":{ "tableBucketARN":{ "shape":"TableBucketARN", - "documentation":"<p>The Amazon Resource Number (ARN) of the table bucket.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the table bucket.</p>", "location":"uri", "locationName":"tableBucketARN" } @@ -878,7 +886,7 @@ "members":{ "resourcePolicy":{ "shape":"ResourcePolicy", - "documentation":"<p>The name of the resource policy.</p>" + "documentation":"<p>The <code>JSON</code> that defines the policy.</p>" } } }, @@ -1070,7 +1078,7 @@ "members":{ "tableBucketARN":{ "shape":"TableBucketARN", - "documentation":"<p>The Amazon Resource Number (ARN) of the table bucket that contains the table.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the table bucket that contains the table.</p>", "location":"uri", "locationName":"tableBucketARN" }, @@ -1094,7 +1102,7 @@ "members":{ "resourcePolicy":{ "shape":"ResourcePolicy", - "documentation":"<p>The name of the resource policy.</p>" + "documentation":"<p>The <code>JSON</code> that defines the policy.</p>" } } }, @@ -1211,6 +1219,28 @@ }, "documentation":"<p>Contains details about the compaction settings for an Iceberg table. </p>" }, + "IcebergMetadata":{ + "type":"structure", + "required":["schema"], + "members":{ + "schema":{ + "shape":"IcebergSchema", + "documentation":"<p>The schema for an Iceberg table.</p>" + } + }, + "documentation":"<p>Contains details about the metadata for an Iceberg table.</p>" + }, + "IcebergSchema":{ + "type":"structure", + "required":["fields"], + "members":{ + "fields":{ + "shape":"SchemaFieldList", + "documentation":"<p>The schema fields for the table</p>" + } + }, + "documentation":"<p>Contains details about the schema for an Iceberg table.</p>" + }, "IcebergSnapshotManagementSettings":{ "type":"structure", "members":{ @@ -1373,7 +1403,7 @@ "members":{ "tableBucketARN":{ "shape":"TableBucketARN", - "documentation":"<p>The Amazon resource Number (ARN) of the table bucket.</p>", + "documentation":"<p>The Amazon resource Name (ARN) of the table bucket.</p>", "location":"uri", "locationName":"tableBucketARN" }, @@ -1538,13 +1568,13 @@ "members":{ "tableBucketARN":{ "shape":"TableBucketARN", - "documentation":"<p>The Amazon Resource Number (ARN) of the table bucket.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the table bucket.</p>", "location":"uri", "locationName":"tableBucketARN" }, "resourcePolicy":{ "shape":"ResourcePolicy", - "documentation":"<p>The name of the resource policy.</p>" + "documentation":"<p>The <code>JSON</code> that defines the policy.</p>" } } }, @@ -1599,7 +1629,7 @@ "members":{ "tableBucketARN":{ "shape":"TableBucketARN", - "documentation":"<p>The Amazon Resource Number (ARN) of the table bucket that contains the table.</p>", + "documentation":"<p>The Amazon Resource Name (ARN) of the table bucket that contains the table.</p>", "location":"uri", "locationName":"tableBucketARN" }, @@ -1617,7 +1647,7 @@ }, "resourcePolicy":{ "shape":"ResourcePolicy", - "documentation":"<p>The name of the resource policy.</p>" + "documentation":"<p>The <code>JSON</code> that defines the policy.</p>" } } }, @@ -1666,6 +1696,32 @@ "max":20480, "min":1 }, + "SchemaField":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"<p>The name of the field.</p>" + }, + "type":{ + "shape":"String", + "documentation":"<p>The field type. S3 Tables supports all Apache Iceberg primitive types. For more information, see the <a href=\"https://iceberg.apache.org/spec/#primitive-types\">Apache Iceberg documentation</a>.</p>" + }, + "required":{ + "shape":"Boolean", + "documentation":"<p>A Boolean value that specifies whether values are required for each row in this field. By default, this is <code>false</code> and null values are allowed in the field. If this is <code>true</code> the field does not allow null values.</p>" + } + }, + "documentation":"<p>Contains details about a schema field.</p>" + }, + "SchemaFieldList":{ + "type":"list", + "member":{"shape":"SchemaField"} + }, "String":{"type":"string"}, "SyntheticTimestamp_date_time":{ "type":"timestamp", @@ -1732,7 +1788,7 @@ "members":{ "arn":{ "shape":"TableBucketARN", - "documentation":"<p>The Amazon Resource Number (ARN) of the table bucket.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the table bucket.</p>" }, "name":{ "shape":"TableBucketName", @@ -1826,6 +1882,17 @@ "icebergSnapshotManagement" ] }, + "TableMetadata":{ + "type":"structure", + "members":{ + "iceberg":{ + "shape":"IcebergMetadata", + "documentation":"<p>Contains details about the metadata of an Iceberg table.</p>" + } + }, + "documentation":"<p>Contains details about the table metadata.</p>", + "union":true + }, "TableName":{ "type":"string", "max":255, @@ -1857,7 +1924,7 @@ }, "tableARN":{ "shape":"TableARN", - "documentation":"<p>The Amazon Resource Number (ARN) of the table.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the table.</p>" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", @@ -1947,7 +2014,7 @@ }, "tableARN":{ "shape":"TableARN", - "documentation":"<p>The Amazon Resource Number (ARN) of the table.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the table.</p>" }, "namespace":{ "shape":"NamespaceList", diff --git a/contrib/python/botocore/py3/botocore/data/sagemaker/2017-07-24/service-2.json b/contrib/python/botocore/py3/botocore/data/sagemaker/2017-07-24/service-2.json index 622ea7e6b39..5edc7d99294 100644 --- a/contrib/python/botocore/py3/botocore/data/sagemaker/2017-07-24/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/sagemaker/2017-07-24/service-2.json @@ -7655,7 +7655,10 @@ "shape":"InstanceGroupTrainingPlanStatus", "documentation":"<p>The current status of the training plan associated with this cluster instance group.</p>" }, - "OverrideVpcConfig":{"shape":"VpcConfig"} + "OverrideVpcConfig":{ + "shape":"VpcConfig", + "documentation":"<p>The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.</p>" + } }, "documentation":"<p>Details of an instance group in a SageMaker HyperPod cluster.</p>" }, @@ -7715,7 +7718,10 @@ "shape":"TrainingPlanArn", "documentation":"<p>The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.</p> <p>For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see <code> <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingPlan.html\">CreateTrainingPlan</a> </code>.</p>" }, - "OverrideVpcConfig":{"shape":"VpcConfig"} + "OverrideVpcConfig":{ + "shape":"VpcConfig", + "documentation":"<p>To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-prerequisites.html#sagemaker-hyperpod-prerequisites-multiple-availability-zones\">Setting up SageMaker HyperPod clusters across multiple AZs</a>.</p> <note> <p>When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:</p> <ul> <li> <p>Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.</p> </li> <li> <p>In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/deploy-ipv6-cluster.html#_deploy_an_ipv6_cluster_with_eksctl\">Amazon EKS IPv6 Cluster Deployment</a>.</p> </li> </ul> <p>Additional resources for IPv6 configuration:</p> <ul> <li> <p>For information about adding IPv6 support to your VPC, see to <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/vpc-migrate-ipv6.html\">IPv6 Support for VPC</a>.</p> </li> <li> <p>For information about creating a new IPv6-compatible VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/create-vpc.html\">Amazon VPC Creation Guide</a>.</p> </li> <li> <p>To configure SageMaker HyperPod with a custom Amazon VPC, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-prerequisites.html#sagemaker-hyperpod-prerequisites-optional-vpc\">Custom Amazon VPC Setup for SageMaker HyperPod</a>.</p> </li> </ul> </note>" + } }, "documentation":"<p>The specifications of an instance group that you need to define.</p>" }, @@ -7725,6 +7731,12 @@ "max":100, "min":1 }, + "ClusterInstanceGroupsToDelete":{ + "type":"list", + "member":{"shape":"ClusterInstanceGroupName"}, + "max":100, + "min":0 + }, "ClusterInstancePlacement":{ "type":"structure", "members":{ @@ -7934,7 +7946,10 @@ "shape":"ClusterLifeCycleConfig", "documentation":"<p>The LifeCycle configuration applied to the instance.</p>" }, - "OverrideVpcConfig":{"shape":"VpcConfig"}, + "OverrideVpcConfig":{ + "shape":"VpcConfig", + "documentation":"<p>The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.</p>" + }, "ThreadsPerCore":{ "shape":"ClusterThreadsPerCore", "documentation":"<p>The number of threads per CPU core you specified under <code>CreateCluster</code>.</p>" @@ -7949,7 +7964,7 @@ }, "PrivatePrimaryIpv6":{ "shape":"ClusterPrivatePrimaryIpv6", - "documentation":"<p>The private primary IPv6 address of the SageMaker HyperPod cluster node.</p>" + "documentation":"<p>The private primary IPv6 address of the SageMaker HyperPod cluster node when configured with an Amazon VPC that supports IPv6 and includes subnets with IPv6 addressing enabled in either the cluster Amazon VPC configuration or the instance group Amazon VPC configuration.</p>" }, "PrivateDnsHostname":{ "shape":"ClusterPrivateDnsHostname", @@ -9311,7 +9326,10 @@ "shape":"ClusterInstanceGroupSpecifications", "documentation":"<p>The instance groups to be created in the SageMaker HyperPod cluster.</p>" }, - "VpcConfig":{"shape":"VpcConfig"}, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"<p>Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html\">Give SageMaker access to resources in your Amazon VPC</a>.</p> <note> <p>When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:</p> <ul> <li> <p>Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.</p> </li> <li> <p>In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/deploy-ipv6-cluster.html#_deploy_an_ipv6_cluster_with_eksctl\">Amazon EKS IPv6 Cluster Deployment</a>.</p> </li> </ul> <p>Additional resources for IPv6 configuration:</p> <ul> <li> <p>For information about adding IPv6 support to your VPC, see to <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/vpc-migrate-ipv6.html\">IPv6 Support for VPC</a>.</p> </li> <li> <p>For information about creating a new IPv6-compatible VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/create-vpc.html\">Amazon VPC Creation Guide</a>.</p> </li> <li> <p>To configure SageMaker HyperPod with a custom Amazon VPC, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-prerequisites.html#sagemaker-hyperpod-prerequisites-optional-vpc\">Custom Amazon VPC Setup for SageMaker HyperPod</a>.</p> </li> </ul> </note>" + }, "Tags":{ "shape":"TagList", "documentation":"<p>Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see <a href=\"https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html\">Tagging Amazon Web Services Resources User Guide</a>.</p>" @@ -29903,7 +29921,7 @@ }, "Image":{ "shape":"ContainerImage", - "documentation":"<p>The Amazon EC2 Container Registry path where inference code is stored.</p> <p>If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both <code>registry/repository[:tag]</code> and <code>registry/repository[@digest]</code> image path formats. For more information, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html\">Using Your Own Algorithms with Amazon SageMaker</a>.</p>" + "documentation":"<p>The Amazon Elastic Container Registry (Amazon ECR) path where inference code is stored.</p> <p>If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both <code>registry/repository[:tag]</code> and <code>registry/repository[@digest]</code> image path formats. For more information, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html\">Using Your Own Algorithms with Amazon SageMaker</a>.</p>" }, "ImageDigest":{ "shape":"ImageDigest", @@ -33595,7 +33613,7 @@ }, "InferenceAmiVersion":{ "shape":"ProductionVariantInferenceAmiVersion", - "documentation":"<p>Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions. Amazon Web Services optimizes these configurations for different machine learning workloads.</p> <p>By selecting an AMI version, you can ensure that your inference environment is compatible with specific software requirements, such as CUDA driver versions, Linux kernel versions, or Amazon Web Services Neuron driver versions.</p> <p>The AMI version names, and their configurations, are the following:</p> <dl> <dt>al2-ami-sagemaker-inference-gpu-2</dt> <dd> <ul> <li> <p>Accelerator: GPU</p> </li> <li> <p>NVIDIA driver version: 535.54.03</p> </li> <li> <p>CUDA driver version: 12.2</p> </li> <li> <p>Supported instance types: ml.g4dn.*, ml.g5.*, ml.g6.*, ml.p3.*, ml.p4d.*, ml.p4de.*, ml.p5.*</p> </li> </ul> </dd> </dl>" + "documentation":"<p>Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions. Amazon Web Services optimizes these configurations for different machine learning workloads.</p> <p>By selecting an AMI version, you can ensure that your inference environment is compatible with specific software requirements, such as CUDA driver versions, Linux kernel versions, or Amazon Web Services Neuron driver versions.</p> <p>The AMI version names, and their configurations, are the following:</p> <dl> <dt>al2-ami-sagemaker-inference-gpu-2</dt> <dd> <ul> <li> <p>Accelerator: GPU</p> </li> <li> <p>NVIDIA driver version: 535</p> </li> <li> <p>CUDA version: 12.2</p> </li> </ul> </dd> <dt>al2-ami-sagemaker-inference-gpu-2-1</dt> <dd> <ul> <li> <p>Accelerator: GPU</p> </li> <li> <p>NVIDIA driver version: 535</p> </li> <li> <p>CUDA version: 12.2</p> </li> <li> <p>NVIDIA Container Toolkit with disabled CUDA-compat mounting</p> </li> </ul> </dd> <dt>al2-ami-sagemaker-inference-gpu-3-1</dt> <dd> <ul> <li> <p>Accelerator: GPU</p> </li> <li> <p>NVIDIA driver version: 550</p> </li> <li> <p>CUDA version: 12.4</p> </li> <li> <p>NVIDIA Container Toolkit with disabled CUDA-compat mounting</p> </li> </ul> </dd> </dl>" } }, "documentation":"<p> Identifies a model that you want to host and the resources chosen to deploy for hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic among the models by specifying variant weights. For more information on production variants, check <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html\"> Production variants</a>. </p>" @@ -33633,7 +33651,11 @@ }, "ProductionVariantInferenceAmiVersion":{ "type":"string", - "enum":["al2-ami-sagemaker-inference-gpu-2"] + "enum":[ + "al2-ami-sagemaker-inference-gpu-2", + "al2-ami-sagemaker-inference-gpu-2-1", + "al2-ami-sagemaker-inference-gpu-3-1" + ] }, "ProductionVariantInstanceType":{ "type":"string", @@ -33748,6 +33770,16 @@ "ml.g6.16xlarge", "ml.g6.24xlarge", "ml.g6.48xlarge", + "ml.r8g.medium", + "ml.r8g.large", + "ml.r8g.xlarge", + "ml.r8g.2xlarge", + "ml.r8g.4xlarge", + "ml.r8g.8xlarge", + "ml.r8g.12xlarge", + "ml.r8g.16xlarge", + "ml.r8g.24xlarge", + "ml.r8g.48xlarge", "ml.g6e.xlarge", "ml.g6e.2xlarge", "ml.g6e.4xlarge", @@ -33824,6 +33856,7 @@ "ml.inf2.48xlarge", "ml.p5.48xlarge", "ml.p5e.48xlarge", + "ml.p5en.48xlarge", "ml.m7i.large", "ml.m7i.xlarge", "ml.m7i.2xlarge", @@ -35325,6 +35358,7 @@ "ml.p5.48xlarge", "ml.p5e.48xlarge", "ml.p5en.48xlarge", + "ml.trn1.32xlarge", "ml.trn2.48xlarge" ] }, @@ -35651,7 +35685,7 @@ }, "SageMakerImageVersionArn":{ "shape":"ImageVersionArn", - "documentation":"<p>The ARN of the image version created on the instance.</p>" + "documentation":"<p>The ARN of the image version created on the instance. To clear the value set for <code>SageMakerImageVersionArn</code>, pass <code>None</code> as the value.</p>" }, "SageMakerImageVersionAlias":{ "shape":"ImageVersionAlias", @@ -35666,7 +35700,7 @@ "documentation":"<p> The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.</p>" } }, - "documentation":"<p>Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.</p>" + "documentation":"<p>Specifies the ARN's of a SageMaker AI image and SageMaker AI image version, and the instance type that the version runs on.</p> <note> <p>When both <code>SageMakerImageVersionArn</code> and <code>SageMakerImageArn</code> are passed, <code>SageMakerImageVersionArn</code> is used. Any updates to <code>SageMakerImageArn</code> will not take effect if <code>SageMakerImageVersionArn</code> already exists in the <code>ResourceSpec</code> because <code>SageMakerImageVersionArn</code> always takes precedence. To clear the value set for <code>SageMakerImageVersionArn</code>, pass <code>None</code> as the value.</p> </note>" }, "ResourceType":{ "type":"string", @@ -40278,6 +40312,10 @@ "NodeRecovery":{ "shape":"ClusterNodeRecovery", "documentation":"<p>The node recovery mode to be applied to the SageMaker HyperPod cluster.</p>" + }, + "InstanceGroupsToDelete":{ + "shape":"ClusterInstanceGroupsToDelete", + "documentation":"<p>Specify the names of the instance groups to delete. Use a single <code>,</code> as the separator between multiple names.</p>" } } }, diff --git a/contrib/python/botocore/py3/botocore/data/security-ir/2018-05-10/service-2.json b/contrib/python/botocore/py3/botocore/data/security-ir/2018-05-10/service-2.json index 104941de852..a41dafc4663 100644 --- a/contrib/python/botocore/py3/botocore/data/security-ir/2018-05-10/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/security-ir/2018-05-10/service-2.json @@ -2244,7 +2244,7 @@ "UserAgent":{ "type":"string", "max":500, - "min":0 + "min":1 }, "ValidationException":{ "type":"structure", diff --git a/contrib/python/botocore/py3/botocore/data/sesv2/2019-09-27/service-2.json b/contrib/python/botocore/py3/botocore/data/sesv2/2019-09-27/service-2.json index 6018ffc67ac..771494e3f35 100644 --- a/contrib/python/botocore/py3/botocore/data/sesv2/2019-09-27/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/sesv2/2019-09-27/service-2.json @@ -1052,6 +1052,22 @@ ], "documentation":"<p>Update your Amazon SES account VDM attributes.</p> <p>You can execute this operation no more than once per second.</p>" }, + "PutConfigurationSetArchivingOptions":{ + "name":"PutConfigurationSetArchivingOptions", + "http":{ + "method":"PUT", + "requestUri":"/v2/email/configuration-sets/{ConfigurationSetName}/archiving-options" + }, + "input":{"shape":"PutConfigurationSetArchivingOptionsRequest"}, + "output":{"shape":"PutConfigurationSetArchivingOptionsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"<p>Associate the configuration set with a MailManager archive. When you send email using the <code>SendEmail</code> or <code>SendBulkEmail</code> operations the message as it will be given to the receiving SMTP server will be archived, along with the recipient information.</p>", + "idempotent":true + }, "PutConfigurationSetDeliveryOptions":{ "name":"PutConfigurationSetDeliveryOptions", "http":{ @@ -1557,6 +1573,22 @@ "exception":true }, "AmazonResourceName":{"type":"string"}, + "ArchiveArn":{ + "type":"string", + "max":1011, + "min":20, + "pattern":"arn:(aws|aws-[a-z-]+):ses:[a-z]{2}-[a-z-]+-[0-9]:[0-9]{1,20}:mailmanager-archive/a-[a-z0-9]{24,62}" + }, + "ArchivingOptions":{ + "type":"structure", + "members":{ + "ArchiveArn":{ + "shape":"ArchiveArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the MailManager archive where the Amazon SES API v2 will archive sent emails.</p>" + } + }, + "documentation":"<p>Used to associate a configuration set with a MailManager archive.</p>" + }, "AttributesData":{"type":"string"}, "BadRequestException":{ "type":"structure", @@ -2054,6 +2086,10 @@ "VdmOptions":{ "shape":"VdmOptions", "documentation":"<p>An object that defines the VDM options for emails that you send using the configuration set.</p>" + }, + "ArchivingOptions":{ + "shape":"ArchivingOptions", + "documentation":"<p>An object that defines the MailManager archiving options for emails that you send using the configuration set.</p>" } }, "documentation":"<p>A request to create a configuration set.</p>" @@ -3718,6 +3754,10 @@ "VdmOptions":{ "shape":"VdmOptions", "documentation":"<p>An object that contains information about the VDM preferences for your configuration set.</p>" + }, + "ArchivingOptions":{ + "shape":"ArchivingOptions", + "documentation":"<p>An object that defines the MailManager archive where sent emails are archived that you send using the configuration set.</p>" } }, "documentation":"<p>Information about a configuration set.</p>" @@ -5187,7 +5227,7 @@ }, "ListRecommendationsFilterKey":{ "type":"string", - "documentation":"<p>The <code>ListRecommendations</code> filter type. This can be one of the following:</p> <ul> <li> <p> <code>TYPE</code> – The recommendation type, with values like <code>DKIM</code>, <code>SPF</code>, <code>DMARC</code> or <code>BIMI</code>.</p> </li> <li> <p> <code>IMPACT</code> – The recommendation impact, with values like <code>HIGH</code> or <code>LOW</code>.</p> </li> <li> <p> <code>STATUS</code> – The recommendation status, with values like <code>OPEN</code> or <code>FIXED</code>.</p> </li> <li> <p> <code>RESOURCE_ARN</code> – The resource affected by the recommendation, with values like <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p> </li> </ul>", + "documentation":"<p>The <code>ListRecommendations</code> filter type. This can be one of the following:</p> <ul> <li> <p> <code>TYPE</code> – The recommendation type, with values like <code>DKIM</code>, <code>SPF</code>, <code>DMARC</code>, <code>BIMI</code>, or <code>COMPLAINT</code>.</p> </li> <li> <p> <code>IMPACT</code> – The recommendation impact, with values like <code>HIGH</code> or <code>LOW</code>.</p> </li> <li> <p> <code>STATUS</code> – The recommendation status, with values like <code>OPEN</code> or <code>FIXED</code>.</p> </li> <li> <p> <code>RESOURCE_ARN</code> – The resource affected by the recommendation, with values like <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p> </li> </ul>", "enum":[ "TYPE", "IMPACT", @@ -5899,6 +5939,29 @@ "members":{ } }, + "PutConfigurationSetArchivingOptionsRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"<p>The name of the configuration set to associate with a MailManager archive.</p>", + "location":"uri", + "locationName":"ConfigurationSetName" + }, + "ArchiveArn":{ + "shape":"ArchiveArn", + "documentation":"<p>The Amazon Resource Name (ARN) of the MailManager archive that the Amazon SES API v2 sends email to.</p>" + } + }, + "documentation":"<p>A request to associate a configuration set with a MailManager archive.</p>" + }, + "PutConfigurationSetArchivingOptionsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"<p>An HTTP 200 response if the request succeeds, or an error message if the request fails.</p>" + }, "PutConfigurationSetDeliveryOptionsRequest":{ "type":"structure", "required":["ConfigurationSetName"], @@ -6344,7 +6407,7 @@ }, "Type":{ "shape":"RecommendationType", - "documentation":"<p>The recommendation type, with values like <code>DKIM</code>, <code>SPF</code>, <code>DMARC</code> or <code>BIMI</code>.</p>" + "documentation":"<p>The recommendation type, with values like <code>DKIM</code>, <code>SPF</code>, <code>DMARC</code>, <code>BIMI</code>, or <code>COMPLAINT</code>.</p>" }, "Description":{ "shape":"RecommendationDescription", @@ -6390,7 +6453,8 @@ "DKIM", "DMARC", "SPF", - "BIMI" + "BIMI", + "COMPLAINT" ] }, "RecommendationsList":{ @@ -7404,7 +7468,7 @@ }, "ErrorType":{ "shape":"VerificationError", - "documentation":"<p>Provides the reason for the failure describing why Amazon SES was not able to successfully verify the identity. Below are the possible values: </p> <ul> <li> <p> <code>INVALID_VALUE</code> – Amazon SES was able to find the record, but the value contained within the record was invalid. Ensure you have published the correct values for the record.</p> </li> <li> <p> <code>TYPE_NOT_FOUND</code> – The queried hostname exists but does not have the requested type of DNS record. Ensure that you have published the correct type of DNS record.</p> </li> <li> <p> <code>HOST_NOT_FOUND</code> – The queried hostname does not exist or was not reachable at the time of the request. Ensure that you have published the required DNS record(s). </p> </li> <li> <p> <code>SERVICE_ERROR</code> – A temporary issue is preventing Amazon SES from determining the verification status of the domain.</p> </li> <li> <p> <code>DNS_SERVER_ERROR</code> – The DNS server encountered an issue and was unable to complete the request.</p> </li> <li> <p> <code>REPLICATION_ACCESS_DENIED</code> – The verification failed because the user does not have the required permissions to replicate the DKIM key from the primary region. Ensure you have the necessary permissions in both primary and replica regions. </p> </li> <li> <p> <code>REPLICATION_PRIMARY_NOT_FOUND</code> – The verification failed because no corresponding identity was found in the specified primary region. Ensure the identity exists in the primary region before attempting replication. </p> </li> <li> <p> <code>REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED</code> – The verification failed because the identity in the primary region is configured with Bring Your Own DKIM (BYODKIM). DKIM key replication is only supported for identities using Easy DKIM. </p> </li> <li> <p> <code>REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED</code> – The verification failed because the specified primary identity is a replica of another identity, and multi-level replication is not supported; the primary identity must be a non-replica identity. </p> </li> <li> <p> <code>REPLICATION_PRIMARY_INVALID_REGION</code> – The verification failed due to an invalid primary region specified. Ensure you provide a valid AWS region where Amazon SES is available and different from the replica region. </p> </li> </ul>" + "documentation":"<p>Provides the reason for the failure describing why Amazon SES was not able to successfully verify the identity. Below are the possible values: </p> <ul> <li> <p> <code>INVALID_VALUE</code> – Amazon SES was able to find the record, but the value contained within the record was invalid. Ensure you have published the correct values for the record.</p> </li> <li> <p> <code>TYPE_NOT_FOUND</code> – The queried hostname exists but does not have the requested type of DNS record. Ensure that you have published the correct type of DNS record.</p> </li> <li> <p> <code>HOST_NOT_FOUND</code> – The queried hostname does not exist or was not reachable at the time of the request. Ensure that you have published the required DNS record(s). </p> </li> <li> <p> <code>SERVICE_ERROR</code> – A temporary issue is preventing Amazon SES from determining the verification status of the domain.</p> </li> <li> <p> <code>DNS_SERVER_ERROR</code> – The DNS server encountered an issue and was unable to complete the request.</p> </li> <li> <p> <code>REPLICATION_ACCESS_DENIED</code> – The verification failed because the user does not have the required permissions to replicate the DKIM key from the primary region. Ensure you have the necessary permissions in both primary and replica regions. </p> </li> <li> <p> <code>REPLICATION_PRIMARY_NOT_FOUND</code> – The verification failed because no corresponding identity was found in the specified primary region. Ensure the identity exists in the primary region before attempting replication. </p> </li> <li> <p> <code>REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED</code> – The verification failed because the identity in the primary region is configured with Bring Your Own DKIM (BYODKIM). DKIM key replication is only supported for identities using Easy DKIM. </p> </li> <li> <p> <code>REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED</code> – The verification failed because the specified primary identity is a replica of another identity, and multi-level replication is not supported; the primary identity must be a non-replica identity. </p> </li> <li> <p> <code>REPLICATION_PRIMARY_INVALID_REGION</code> – The verification failed due to an invalid primary region specified. Ensure you provide a valid Amazon Web Services region where Amazon SES is available and different from the replica region. </p> </li> </ul>" }, "SOARecord":{ "shape":"SOARecord", diff --git a/contrib/python/botocore/py3/botocore/data/sns/2010-03-31/service-2.json b/contrib/python/botocore/py3/botocore/data/sns/2010-03-31/service-2.json index 8ff9f4cd24e..70dd2549b9b 100644 --- a/contrib/python/botocore/py3/botocore/data/sns/2010-03-31/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/sns/2010-03-31/service-2.json @@ -1099,7 +1099,7 @@ }, "Attributes":{ "shape":"TopicAttributesMap", - "documentation":"<p>A map of attributes with their corresponding values.</p> <p>The following lists names, descriptions, and values of the special request parameters that the <code>CreateTopic</code> action uses:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li> <li> <p> <code>FifoTopic</code> – Set to true to create a FIFO topic.</p> </li> <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li> <li> <p> <code>SignatureVersion</code> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, <code>SignatureVersion</code> is set to <code>1</code>.</p> </li> <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to <code>Active</code>, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li> </ul> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html\">server-side encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms\">Key Terms</a>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the <i>Key Management Service API Reference</i>. </p> </li> </ul> <p>The following attributes apply only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html\">FIFO topics</a>:</p> <ul> <li> <p> <code>ArchivePolicy</code> – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic.</p> </li> <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p> <ul> <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href=\"https://docs.aws.amazon.com/sns/latest/api/API_Publish.html\">Publish</a> action. </p> </li> <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li> </ul> </li> </ul>" + "documentation":"<p>A map of attributes with their corresponding values.</p> <p>The following lists names, descriptions, and values of the special request parameters that the <code>CreateTopic</code> action uses:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li> <li> <p> <code>FifoTopic</code> – Set to true to create a FIFO topic.</p> </li> <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li> <li> <p> <code>SignatureVersion</code> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, <code>SignatureVersion</code> is set to <code>1</code>.</p> </li> <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to <code>Active</code>, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li> </ul> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html\">server-side encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms\">Key Terms</a>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the <i>Key Management Service API Reference</i>. </p> </li> </ul> <p>The following attributes apply only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html\">FIFO topics</a>:</p> <ul> <li> <p> <code>ArchivePolicy</code> – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic.</p> </li> <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p> <ul> <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href=\"https://docs.aws.amazon.com/sns/latest/api/API_Publish.html\">Publish</a> action. </p> </li> <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li> </ul> </li> </ul> <ul> <li> <p> <code>FifoThroughputScope</code> – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:</p> <ul> <li> <p> <code>Topic</code> – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.</p> </li> <li> <p> <code>MessageGroup</code> – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/sns.html\">Amazon SNS service quotas</a> in the Amazon Web Services General Reference.</p> </li> </ul> </li> </ul>" }, "Tags":{ "shape":"TagList", @@ -2022,7 +2022,7 @@ }, "MessageDeduplicationId":{ "shape":"String", - "documentation":"<p>This parameter applies only to FIFO (first-in-first-out) topics.</p> <p>The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, subsequent messages with the same <code>MessageDeduplicationId</code> are accepted successfully but aren't delivered.</p> <ul> <li> <p>Every message must have a unique <code>MessageDeduplicationId</code>.</p> <ul> <li> <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your topic, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> </li> <li> <p>If you don't provide a <code>MessageDeduplicationId</code> and the topic doesn't have <code>ContentBasedDeduplication</code> set, the action fails with an error.</p> </li> <li> <p>If the topic has a <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. </p> </li> </ul> </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If you send one message with <code>ContentBasedDeduplication</code> enabled, and then another message with a <code>MessageDeduplicationId</code> that is the same as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered. </p> </li> </ul> <note> <p>The <code>MessageDeduplicationId</code> is available to the consumer of the message (this can be useful for troubleshooting delivery issues).</p> <p>If a message is sent successfully but the acknowledgement is lost and the message is resent with the same <code>MessageDeduplicationId</code> after the deduplication interval, Amazon SNS can't detect duplicate messages. </p> <p>Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted. </p> </note> <p>The length of <code>MessageDeduplicationId</code> is 128 characters.</p> <p> <code>MessageDeduplicationId</code> can contain alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)</code>.</p>" + "documentation":"<p>This parameter applies only to FIFO (first-in-first-out) topics.</p> <ul> <li> <p>This parameter applies only to FIFO (first-in-first-out) topics. The <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)</code>.</p> </li> <li> <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is a token used for deduplication of sent messages within the 5 minute minimum deduplication interval.</p> </li> <li> <p>The scope of deduplication depends on the <code>FifoThroughputScope</code> attribute, when set to <code>Topic</code> the message deduplication scope is across the entire topic, when set to <code>MessageGroup</code> the message deduplication scope is within each individual message group. </p> </li> <li> <p>If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, subsequent messages within the deduplication scope and interval, with the same <code>MessageDeduplicationId</code>, are accepted successfully but aren't delivered.</p> </li> <li> <p>Every message must have a unique <code>MessageDeduplicationId</code>.</p> <ul> <li> <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your topic, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> </li> <li> <p>If you don't provide a <code>MessageDeduplicationId</code> and the topic doesn't have <code>ContentBasedDeduplication</code> set, the action fails with an error.</p> </li> <li> <p>If the topic has a <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. </p> </li> </ul> </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication scope and interval are treated as duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If you send one message with <code>ContentBasedDeduplication</code> enabled, and then another message with a <code>MessageDeduplicationId</code> that is the same as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates, within the deduplication scope and interval, and only one copy of the message is delivered. </p> </li> </ul> <note> <p>The <code>MessageDeduplicationId</code> is available to the consumer of the message (this can be useful for troubleshooting delivery issues).</p> <p>If a message is sent successfully but the acknowledgement is lost and the message is resent with the same <code>MessageDeduplicationId</code> after the deduplication interval, Amazon SNS can't detect duplicate messages. </p> <p>Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted. </p> </note>" }, "MessageGroupId":{ "shape":"String", @@ -2104,7 +2104,7 @@ }, "MessageDeduplicationId":{ "shape":"String", - "documentation":"<p>This parameter applies only to FIFO (first-in-first-out) topics. The <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)</code>.</p> <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is a token used for deduplication of sent messages. If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, any message sent with the same <code>MessageDeduplicationId</code> during the 5-minute deduplication interval is treated as a duplicate. </p> <p>If the topic has <code>ContentBasedDeduplication</code> set, the system generates a <code>MessageDeduplicationId</code> based on the contents of the message. Your <code>MessageDeduplicationId</code> overrides the generated one.</p>" + "documentation":"<ul> <li> <p>This parameter applies only to FIFO (first-in-first-out) topics. The <code>MessageDeduplicationId</code> can contain up to 128 alphanumeric characters <code>(a-z, A-Z, 0-9)</code> and punctuation <code>(!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)</code>.</p> </li> <li> <p>Every message must have a unique <code>MessageDeduplicationId</code>, which is a token used for deduplication of sent messages within the 5 minute minimum deduplication interval.</p> </li> <li> <p>The scope of deduplication depends on the <code>FifoThroughputScope</code> attribute, when set to <code>Topic</code> the message deduplication scope is across the entire topic, when set to <code>MessageGroup</code> the message deduplication scope is within each individual message group.</p> </li> <li> <p>If a message with a particular <code>MessageDeduplicationId</code> is sent successfully, subsequent messages within the deduplication scope and interval, with the same <code>MessageDeduplicationId</code>, are accepted successfully but aren't delivered.</p> </li> <li> <p>Every message must have a unique <code>MessageDeduplicationId</code>:</p> <ul> <li> <p>You may provide a <code>MessageDeduplicationId</code> explicitly.</p> </li> <li> <p>If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your topic, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> </li> <li> <p>If you don't provide a <code>MessageDeduplicationId</code> and the topic doesn't have <code>ContentBasedDeduplication</code> set, the action fails with an error.</p> </li> <li> <p>If the topic has a <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. </p> </li> </ul> </li> <li> <p>When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication scope and interval are treated as duplicates and only one copy of the message is delivered.</p> </li> <li> <p>If you send one message with <code>ContentBasedDeduplication</code> enabled, and then another message with a <code>MessageDeduplicationId</code> that is the same as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates, within the deduplication scope and interval, and only one copy of the message is delivered.</p> </li> </ul>" }, "MessageGroupId":{ "shape":"String", @@ -2311,7 +2311,7 @@ }, "AttributeName":{ "shape":"attributeName", - "documentation":"<p>A map of attributes with their corresponding values.</p> <p>The following lists the names, descriptions, and values of the special request parameters that the <code>SetTopicAttributes</code> action uses:</p> <ul> <li> <p> <code>ApplicationSuccessFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.</p> </li> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li> <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li> <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to <code>Active</code>, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li> <li> <p>HTTP</p> <ul> <li> <p> <code>HTTPSuccessFeedbackRoleArn</code> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint. </p> </li> <li> <p> <code>HTTPSuccessFeedbackSampleRate</code> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.</p> </li> <li> <p> <code>HTTPFailureFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.</p> </li> </ul> </li> <li> <p>Amazon Kinesis Data Firehose</p> <ul> <li> <p> <code>FirehoseSuccessFeedbackRoleArn</code> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.</p> </li> <li> <p> <code>FirehoseSuccessFeedbackSampleRate</code> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.</p> </li> <li> <p> <code>FirehoseFailureFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint. </p> </li> </ul> </li> <li> <p>Lambda</p> <ul> <li> <p> <code>LambdaSuccessFeedbackRoleArn</code> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.</p> </li> <li> <p> <code>LambdaSuccessFeedbackSampleRate</code> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.</p> </li> <li> <p> <code>LambdaFailureFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint. </p> </li> </ul> </li> <li> <p>Platform application endpoint</p> <ul> <li> <p> <code>ApplicationSuccessFeedbackRoleArn</code> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.</p> </li> <li> <p> <code>ApplicationSuccessFeedbackSampleRate</code> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.</p> </li> <li> <p> <code>ApplicationFailureFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.</p> </li> </ul> <note> <p>In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.</p> <p>For example, For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html\">Using Amazon SNS Application Attributes for Message Delivery Status</a>. </p> </note> </li> <li> <p>Amazon SQS</p> <ul> <li> <p> <code>SQSSuccessFeedbackRoleArn</code> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. </p> </li> <li> <p> <code>SQSSuccessFeedbackSampleRate</code> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. </p> </li> <li> <p> <code>SQSFailureFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. </p> </li> </ul> </li> </ul> <note> <p>The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. </p> </note> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html\">server-side-encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms\">Key Terms</a>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the <i>Key Management Service API Reference</i>. </p> </li> <li> <p> <code>SignatureVersion</code> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, <code>SignatureVersion</code> is set to <code>1</code>.</p> </li> </ul> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html\">FIFO topics</a>:</p> <ul> <li> <p> <code>ArchivePolicy</code> – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic.</p> </li> <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p> <ul> <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href=\"https://docs.aws.amazon.com/sns/latest/api/API_Publish.html\">Publish</a> action. </p> </li> <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li> </ul> </li> </ul>" + "documentation":"<p>A map of attributes with their corresponding values.</p> <p>The following lists the names, descriptions, and values of the special request parameters that the <code>SetTopicAttributes</code> action uses:</p> <ul> <li> <p> <code>ApplicationSuccessFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.</p> </li> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li> <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li> <li> <p> <code>TracingConfig</code> – Tracing mode of an Amazon SNS topic. By default <code>TracingConfig</code> is set to <code>PassThrough</code>, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to <code>Active</code>, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.</p> </li> <li> <p>HTTP</p> <ul> <li> <p> <code>HTTPSuccessFeedbackRoleArn</code> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint. </p> </li> <li> <p> <code>HTTPSuccessFeedbackSampleRate</code> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.</p> </li> <li> <p> <code>HTTPFailureFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.</p> </li> </ul> </li> <li> <p>Amazon Kinesis Data Firehose</p> <ul> <li> <p> <code>FirehoseSuccessFeedbackRoleArn</code> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.</p> </li> <li> <p> <code>FirehoseSuccessFeedbackSampleRate</code> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.</p> </li> <li> <p> <code>FirehoseFailureFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint. </p> </li> </ul> </li> <li> <p>Lambda</p> <ul> <li> <p> <code>LambdaSuccessFeedbackRoleArn</code> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.</p> </li> <li> <p> <code>LambdaSuccessFeedbackSampleRate</code> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.</p> </li> <li> <p> <code>LambdaFailureFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint. </p> </li> </ul> </li> <li> <p>Platform application endpoint</p> <ul> <li> <p> <code>ApplicationSuccessFeedbackRoleArn</code> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.</p> </li> <li> <p> <code>ApplicationSuccessFeedbackSampleRate</code> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.</p> </li> <li> <p> <code>ApplicationFailureFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.</p> </li> </ul> <note> <p>In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.</p> <p>For example, For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html\">Using Amazon SNS Application Attributes for Message Delivery Status</a>. </p> </note> </li> <li> <p>Amazon SQS</p> <ul> <li> <p> <code>SQSSuccessFeedbackRoleArn</code> – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. </p> </li> <li> <p> <code>SQSSuccessFeedbackSampleRate</code> – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. </p> </li> <li> <p> <code>SQSFailureFeedbackRoleArn</code> – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint. </p> </li> </ul> </li> </ul> <note> <p>The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. </p> </note> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html\">server-side-encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms\">Key Terms</a>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the <i>Key Management Service API Reference</i>. </p> </li> <li> <p> <code>SignatureVersion</code> – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, <code>SignatureVersion</code> is set to <code>1</code>.</p> </li> </ul> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html\">FIFO topics</a>:</p> <ul> <li> <p> <code>ArchivePolicy</code> – The policy that sets the retention period for messages stored in the message archive of an Amazon SNS FIFO topic.</p> </li> <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication for FIFO topics.</p> <ul> <li> <p>By default, <code>ContentBasedDeduplication</code> is set to <code>false</code>. If you create a FIFO topic and this attribute is <code>false</code>, you must specify a value for the <code>MessageDeduplicationId</code> parameter for the <a href=\"https://docs.aws.amazon.com/sns/latest/api/API_Publish.html\">Publish</a> action. </p> </li> <li> <p>When you set <code>ContentBasedDeduplication</code> to <code>true</code>, Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message).</p> <p>(Optional) To override the generated value, you can specify a value for the <code>MessageDeduplicationId</code> parameter for the <code>Publish</code> action.</p> </li> </ul> </li> </ul> <ul> <li> <p> <code>FifoThroughputScope</code> – Enables higher throughput for your FIFO topic by adjusting the scope of deduplication. This attribute has two possible values:</p> <ul> <li> <p> <code>Topic</code> – The scope of message deduplication is across the entire topic. This is the default value and maintains existing behavior, with a maximum throughput of 3000 messages per second or 20MB per second, whichever comes first.</p> </li> <li> <p> <code>MessageGroup</code> – The scope of deduplication is within each individual message group, which enables higher throughput per topic subject to regional quotas. For more information on quotas or to request an increase, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/sns.html\">Amazon SNS service quotas</a> in the Amazon Web Services General Reference.</p> </li> </ul> </li> </ul>" }, "AttributeValue":{ "shape":"attributeValue", diff --git a/contrib/python/botocore/py3/botocore/data/ssm/2014-11-06/service-2.json b/contrib/python/botocore/py3/botocore/data/ssm/2014-11-06/service-2.json index de7db8a0442..bcbff684a55 100644 --- a/contrib/python/botocore/py3/botocore/data/ssm/2014-11-06/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/ssm/2014-11-06/service-2.json @@ -48,7 +48,7 @@ {"shape":"OpsItemRelatedItemAlreadyExistsException"}, {"shape":"OpsItemConflictException"} ], - "documentation":"<p>Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.</p>" + "documentation":"<p>Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in Amazon Web Services Systems Manager.</p>" }, "CancelCommand":{ "name":"CancelCommand", @@ -92,7 +92,7 @@ {"shape":"InvalidParameters"}, {"shape":"InternalServerError"} ], - "documentation":"<p>Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-hybrid-multicloud.html\">Using Amazon Web Services Systems Manager in hybrid and multicloud environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p> <note> <p>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called <i>managed nodes</i>.</p> </note>" + "documentation":"<p>Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager tools. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-hybrid-multicloud.html\">Using Amazon Web Services Systems Manager in hybrid and multicloud environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p> <note> <p>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called <i>managed nodes</i>.</p> </note>" }, "CreateAssociation":{ "name":"CreateAssociation", @@ -117,7 +117,7 @@ {"shape":"InvalidTargetMaps"}, {"shape":"InvalidTag"} ], - "documentation":"<p>A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service. </p>" + "documentation":"<p>A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a tool in Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service. </p>" }, "CreateAssociationBatch":{ "name":"CreateAssociationBatch", @@ -985,7 +985,7 @@ {"shape":"OpsItemInvalidParameterException"}, {"shape":"OpsItemConflictException"} ], - "documentation":"<p>Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.</p>" + "documentation":"<p>Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in Amazon Web Services Systems Manager.</p>" }, "GetAutomationExecution":{ "name":"GetAutomationExecution", @@ -1015,7 +1015,7 @@ {"shape":"InvalidDocumentType"}, {"shape":"UnsupportedCalendarException"} ], - "documentation":"<p>Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, <code>GetCalendarState</code> returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, <code>GetCalendarState</code> uses the current time. Change Calendar entries have two possible states: <code>OPEN</code> or <code>CLOSED</code>.</p> <p>If you specify more than one calendar in a request, the command returns the status of <code>OPEN</code> only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is <code>CLOSED</code>.</p> <p>For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html\">Amazon Web Services Systems Manager Change Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" + "documentation":"<p>Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, <code>GetCalendarState</code> returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, <code>GetCalendarState</code> uses the current time. Change Calendar entries have two possible states: <code>OPEN</code> or <code>CLOSED</code>.</p> <p>If you specify more than one calendar in a request, the command returns the status of <code>OPEN</code> only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is <code>CLOSED</code>.</p> <p>For more information about Change Calendar, a tool in Amazon Web Services Systems Manager, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html\">Amazon Web Services Systems Manager Change Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" }, "GetCommandInvocation":{ "name":"GetCommandInvocation", @@ -1073,7 +1073,7 @@ {"shape":"UnsupportedOperatingSystem"}, {"shape":"UnsupportedFeatureRequiredException"} ], - "documentation":"<p>Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the <code>AWS-RunPatchBaseline</code> Systems Manager document (SSM document).</p> <note> <p>If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the <code>AWS-RunShellScript</code> document or the <code>AWS-RunPowerShellScript</code> document.</p> </note>" + "documentation":"<p>Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the <code>AWS-RunPatchBaseline</code> Systems Manager document (SSM document).</p> <note> <p>If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a tool in Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the <code>AWS-RunShellScript</code> document or the <code>AWS-RunPowerShellScript</code> document.</p> </note>" }, "GetDocument":{ "name":"GetDocument", @@ -1318,7 +1318,7 @@ {"shape":"InvalidKeyId"}, {"shape":"InvalidNextToken"} ], - "documentation":"<p>Retrieve information about one or more parameters in a specific hierarchy. </p> <p>Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of <code>MaxResults</code>. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a <code>NextToken</code>. You can specify the <code>NextToken</code> in a subsequent call to get the next set of results.</p>" + "documentation":"<p>Retrieve information about one or more parameters under a specified level in a hierarchy. </p> <p>Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of <code>MaxResults</code>. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a <code>NextToken</code>. You can specify the <code>NextToken</code> in a subsequent call to get the next set of results.</p>" }, "GetPatchBaseline":{ "name":"GetPatchBaseline", @@ -1421,7 +1421,7 @@ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"} ], - "documentation":"<p>Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>" + "documentation":"<p>Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a tool in Amazon Web Services Systems Manager.</p>" }, "ListCommandInvocations":{ "name":"ListCommandInvocations", @@ -1615,7 +1615,7 @@ {"shape":"InternalServerError"}, {"shape":"OpsItemInvalidParameterException"} ], - "documentation":"<p>Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.</p>" + "documentation":"<p>Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.</p>" }, "ListOpsMetadata":{ "name":"ListOpsMetadata", @@ -2675,7 +2675,7 @@ }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", - "documentation":"<p>Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.</p>" + "documentation":"<p>Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.</p>" }, "Parameters":{ "shape":"Parameters", @@ -2723,7 +2723,7 @@ }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", - "documentation":"<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>" + "documentation":"<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", @@ -3161,7 +3161,7 @@ }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", - "documentation":"<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>" + "documentation":"<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", @@ -4068,7 +4068,7 @@ }, "ServiceRole":{ "shape":"ServiceRole", - "documentation":"<p>The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes. </p>" + "documentation":"<p>The Identity and Access Management (IAM) service role that Run Command, a tool in Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes. </p>" }, "NotificationConfig":{ "shape":"NotificationConfig", @@ -4194,7 +4194,7 @@ }, "ServiceRole":{ "shape":"ServiceRole", - "documentation":"<p>The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.</p>" + "documentation":"<p>The Identity and Access Management (IAM) service role that Run Command, a tool in Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per managed node basis.</p>" }, "NotificationConfig":{ "shape":"NotificationConfig", @@ -4684,7 +4684,7 @@ }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", - "documentation":"<p>Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.</p>" + "documentation":"<p>Specify the target for the association. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.</p>" }, "DocumentVersion":{ "shape":"DocumentVersion", @@ -4720,7 +4720,7 @@ }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", - "documentation":"<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>. </p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>" + "documentation":"<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>. </p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", @@ -4804,7 +4804,7 @@ }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", - "documentation":"<p>Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.</p>" + "documentation":"<p>Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.</p>" }, "MaxErrors":{ "shape":"MaxErrors", @@ -6685,7 +6685,7 @@ }, "InstancesWithUnreportedNotApplicablePatches":{ "shape":"Integer", - "documentation":"<p>The number of managed nodes with <code>NotApplicable</code> patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.</p>", + "documentation":"<p>The number of managed nodes with <code>NotApplicable</code> patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.</p>", "box":true }, "InstancesWithCriticalNonCompliantPatches":{ @@ -9355,7 +9355,7 @@ }, "UnreportedNotApplicableCount":{ "shape":"PatchUnreportedNotApplicableCount", - "documentation":"<p>The number of patches beyond the supported limit of <code>NotApplicableCount</code> that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.</p>", + "documentation":"<p>The number of patches beyond the supported limit of <code>NotApplicableCount</code> that aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.</p>", "box":true }, "NotApplicableCount":{ @@ -13540,7 +13540,7 @@ }, "PolicyType":{ "shape":"String", - "documentation":"<p>The type of policy. Parameter Store, a capability of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification. </p>" + "documentation":"<p>The type of policy. Parameter Store, a tool in Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification. </p>" }, "PolicyStatus":{ "shape":"String", @@ -14563,7 +14563,7 @@ }, "Value":{ "shape":"PSParameterValue", - "documentation":"<p>The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.</p> <note> <p>Parameters can't be referenced or nested in the values of other parameters. You can't include <code>{{}}</code> or <code>{{ssm:<i>parameter-name</i>}}</code> in a parameter value.</p> </note>" + "documentation":"<p>The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.</p> <note> <p>Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets <code>{{}}</code> or <code>{{ssm:<i>parameter-name</i>}}</code> in a parameter value.</p> </note>" }, "Type":{ "shape":"ParameterType", @@ -14592,7 +14592,7 @@ }, "Policies":{ "shape":"ParameterPolicies", - "documentation":"<p>One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a capability of Amazon Web Services Systems Manager supports the following policy types:</p> <p>Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the <i>parameter</i> doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.</p> <p>ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.</p> <p>NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.</p> <p>All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html\">Assigning parameter policies</a>. </p>" + "documentation":"<p>One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in Amazon Web Services Systems Manager supports the following policy types:</p> <p>Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the <i>parameter</i> doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.</p> <p>ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.</p> <p>NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.</p> <p>All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html\">Assigning parameter policies</a>. </p>" }, "DataType":{ "shape":"ParameterDataType", @@ -15729,7 +15729,7 @@ }, "CloudWatchOutputConfig":{ "shape":"CloudWatchOutputConfig", - "documentation":"<p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.</p>" + "documentation":"<p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a tool in Amazon Web Services Systems Manager.</p>" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", @@ -16123,7 +16123,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=environment,Value=test</code> </p> </li> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> </ul> <note> <p>To add tags to an existing automation, use the <a>AddTagsToResource</a> operation.</p> </note>" + "documentation":"<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=environment,Value=test</code> </p> </li> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> </ul> <note> <p>The <code>Array Members</code> maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the <code>StartAutomationExecution</code> action, you can specify a maximum of 5 tags. You can, however, use the <a>AddTagsToResource</a> action to add up to a total of 50 tags to an existing automation configuration.</p> </note>" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", @@ -16186,7 +16186,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=Environment,Value=Production</code> </p> </li> <li> <p> <code>Key=Region,Value=us-east-2</code> </p> </li> </ul>" + "documentation":"<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=Environment,Value=Production</code> </p> </li> <li> <p> <code>Key=Region,Value=us-east-2</code> </p> </li> </ul> <note> <p>The <code>Array Members</code> maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the <code>StartChangeRequestExecution</code> action, you can specify a maximum of 5 tags. You can, however, use the <a>AddTagsToResource</a> action to add up to a total of 50 tags to an existing change request configuration.</p> </note>" }, "ScheduledEndTime":{ "shape":"DateTime", @@ -16252,7 +16252,7 @@ }, "Parameters":{ "shape":"SessionManagerParameters", - "documentation":"<p>The values you want to specify for the parameters defined in the Session document.</p>" + "documentation":"<p>The values you want to specify for the parameters defined in the Session document. For more information about these parameters, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/getting-started-create-preferences-cli.html\">Create a Session Manager preferences document</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" } } }, @@ -16553,7 +16553,7 @@ "documentation":"<p>User-defined criteria that maps to <code>Key</code>. For example, if you specified <code>tag:ServerRole</code>, you could specify <code>value:WebServer</code> to run a command on instances that include EC2 tags of <code>ServerRole,WebServer</code>. </p> <p>Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.</p>" } }, - "documentation":"<p>An array of search criteria that targets managed nodes using a key-value pair that you specify.</p> <note> <p> One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </note> <p>Supported formats include the following.</p> <p> <b>For all Systems Manager capabilities:</b> </p> <ul> <li> <p> <code>Key=tag-key,Values=tag-value-1,tag-value-2</code> </p> </li> </ul> <p> <b>For Automation and Change Manager:</b> </p> <ul> <li> <p> <code>Key=tag:tag-key,Values=tag-value</code> </p> </li> <li> <p> <code>Key=ResourceGroup,Values=resource-group-name</code> </p> </li> <li> <p> <code>Key=ParameterValues,Values=value-1,value-2,value-3</code> </p> </li> <li> <p>To target all instances in the Amazon Web Services Region:</p> <ul> <li> <p> <code>Key=AWS::EC2::Instance,Values=*</code> </p> </li> <li> <p> <code>Key=InstanceIds,Values=*</code> </p> </li> </ul> </li> </ul> <p> <b>For Run Command and Maintenance Windows:</b> </p> <ul> <li> <p> <code>Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3</code> </p> </li> <li> <p> <code>Key=tag:tag-key,Values=tag-value-1,tag-value-2</code> </p> </li> <li> <p> <code>Key=resource-groups:Name,Values=resource-group-name</code> </p> </li> <li> <p>Additionally, Maintenance Windows support targeting resource types:</p> <ul> <li> <p> <code>Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2</code> </p> </li> </ul> </li> </ul> <p> <b>For State Manager:</b> </p> <ul> <li> <p> <code>Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3</code> </p> </li> <li> <p> <code>Key=tag:tag-key,Values=tag-value-1,tag-value-2</code> </p> </li> <li> <p>To target all instances in the Amazon Web Services Region:</p> <ul> <li> <p> <code>Key=InstanceIds,Values=*</code> </p> </li> </ul> </li> </ul> <p>For more information about how to send commands that target managed nodes using <code>Key,Value</code> parameters, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting\">Targeting multiple managed nodes</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" + "documentation":"<p>An array of search criteria that targets managed nodes using a key-value pair that you specify.</p> <note> <p> One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html\">Registering maintenance window tasks without targets</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </note> <p>Supported formats include the following.</p> <p> <b>For all Systems Manager tools:</b> </p> <ul> <li> <p> <code>Key=tag-key,Values=tag-value-1,tag-value-2</code> </p> </li> </ul> <p> <b>For Automation and Change Manager:</b> </p> <ul> <li> <p> <code>Key=tag:tag-key,Values=tag-value</code> </p> </li> <li> <p> <code>Key=ResourceGroup,Values=resource-group-name</code> </p> </li> <li> <p> <code>Key=ParameterValues,Values=value-1,value-2,value-3</code> </p> </li> <li> <p>To target all instances in the Amazon Web Services Region:</p> <ul> <li> <p> <code>Key=AWS::EC2::Instance,Values=*</code> </p> </li> <li> <p> <code>Key=InstanceIds,Values=*</code> </p> </li> </ul> </li> </ul> <p> <b>For Run Command and Maintenance Windows:</b> </p> <ul> <li> <p> <code>Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3</code> </p> </li> <li> <p> <code>Key=tag:tag-key,Values=tag-value-1,tag-value-2</code> </p> </li> <li> <p> <code>Key=resource-groups:Name,Values=resource-group-name</code> </p> </li> <li> <p>Additionally, Maintenance Windows support targeting resource types:</p> <ul> <li> <p> <code>Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2</code> </p> </li> </ul> </li> </ul> <p> <b>For State Manager:</b> </p> <ul> <li> <p> <code>Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3</code> </p> </li> <li> <p> <code>Key=tag:tag-key,Values=tag-value-1,tag-value-2</code> </p> </li> <li> <p>To target all instances in the Amazon Web Services Region:</p> <ul> <li> <p> <code>Key=InstanceIds,Values=*</code> </p> </li> </ul> </li> </ul> <p>For more information about how to send commands that target managed nodes using <code>Key,Value</code> parameters, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-targeting\">Targeting multiple managed nodes</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>" }, "TargetCount":{"type":"integer"}, "TargetInUseException":{ @@ -16880,7 +16880,7 @@ }, "Parameters":{ "shape":"Parameters", - "documentation":"<p>The parameters you want to update for the association. If you create a parameter using Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference the parameter using <code>{{ssm:parameter-name}}</code>.</p>" + "documentation":"<p>The parameters you want to update for the association. If you create a parameter using Parameter Store, a tool in Amazon Web Services Systems Manager, you can reference the parameter using <code>{{ssm:parameter-name}}</code>.</p>" }, "DocumentVersion":{ "shape":"DocumentVersion", @@ -16912,7 +16912,7 @@ }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", - "documentation":"<p>Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.</p>" + "documentation":"<p>Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.</p>" }, "MaxErrors":{ "shape":"MaxErrors", @@ -16928,7 +16928,7 @@ }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", - "documentation":"<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>" + "documentation":"<p>The mode for generating association compliance. You can specify <code>AUTO</code> or <code>MANUAL</code>. In <code>AUTO</code> mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is <code>COMPLIANT</code>. If the association execution doesn't run successfully, the association is <code>NON-COMPLIANT</code>.</p> <p>In <code>MANUAL</code> mode, you must specify the <code>AssociationId</code> as a parameter for the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the <a>PutComplianceItems</a> API operation.</p> <p>By default, all associations use <code>AUTO</code> mode.</p>" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", @@ -17749,5 +17749,5 @@ "pattern":"^[0-9]{1,6}(\\.[0-9]{1,6}){2,3}$" } }, - "documentation":"<p>Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.</p> <p>This reference is intended to be used with the <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/\">Amazon Web Services Systems Manager User Guide</a>. To get started, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html\">Setting up Amazon Web Services Systems Manager</a>.</p> <p class=\"title\"> <b>Related resources</b> </p> <ul> <li> <p>For information about each of the capabilities that comprise Systems Manager, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities\">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </li> <li> <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the <i> <a href=\"https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html\">Systems Manager Automation runbook reference</a> </i>.</p> </li> <li> <p>For information about AppConfig, a capability of Systems Manager, see the <i> <a href=\"https://docs.aws.amazon.com/appconfig/latest/userguide/\">AppConfig User Guide</a> </i> and the <i> <a href=\"https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/\">AppConfig API Reference</a> </i>.</p> </li> <li> <p>For information about Incident Manager, a capability of Systems Manager, see the <i> <a href=\"https://docs.aws.amazon.com/incident-manager/latest/userguide/\">Systems Manager Incident Manager User Guide</a> </i> and the <i> <a href=\"https://docs.aws.amazon.com/incident-manager/latest/APIReference/\">Systems Manager Incident Manager API Reference</a> </i>.</p> </li> </ul>" + "documentation":"<p>Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.</p> <p>This reference is intended to be used with the <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/\">Amazon Web Services Systems Manager User Guide</a>. To get started, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html\">Setting up Amazon Web Services Systems Manager</a>.</p> <p class=\"title\"> <b>Related resources</b> </p> <ul> <li> <p>For information about each of the tools that comprise Systems Manager, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-tools.html\">Using Systems Manager tools</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p> </li> <li> <p>For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the <i> <a href=\"https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html\">Systems Manager Automation runbook reference</a> </i>.</p> </li> <li> <p>For information about AppConfig, a tool in Systems Manager, see the <i> <a href=\"https://docs.aws.amazon.com/appconfig/latest/userguide/\">AppConfig User Guide</a> </i> and the <i> <a href=\"https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/\">AppConfig API Reference</a> </i>.</p> </li> <li> <p>For information about Incident Manager, a tool in Systems Manager, see the <i> <a href=\"https://docs.aws.amazon.com/incident-manager/latest/userguide/\">Systems Manager Incident Manager User Guide</a> </i> and the <i> <a href=\"https://docs.aws.amazon.com/incident-manager/latest/APIReference/\">Systems Manager Incident Manager API Reference</a> </i>.</p> </li> </ul>" } diff --git a/contrib/python/botocore/py3/botocore/data/sso-oidc/2019-06-10/service-2.json b/contrib/python/botocore/py3/botocore/data/sso-oidc/2019-06-10/service-2.json index 5b32e9bc707..d2e3b11a792 100644 --- a/contrib/python/botocore/py3/botocore/data/sso-oidc/2019-06-10/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/sso-oidc/2019-06-10/service-2.json @@ -11,7 +11,8 @@ "serviceId":"SSO OIDC", "signatureVersion":"v4", "signingName":"sso-oauth", - "uid":"sso-oidc-2019-06-10" + "uid":"sso-oidc-2019-06-10", + "auth":["aws.auth#sigv4"] }, "operations":{ "CreateToken":{ @@ -35,8 +36,9 @@ {"shape":"ExpiredTokenException"}, {"shape":"InternalServerException"} ], - "documentation":"<p>Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-term credentials for the assigned AWS accounts or to access application APIs using <code>bearer</code> authentication.</p>", - "authtype":"none" + "documentation":"<p>Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-lived credentials for the assigned AWS accounts or to access application APIs using <code>bearer</code> authentication.</p>", + "authtype":"none", + "auth":["smithy.api#noAuth"] }, "CreateTokenWithIAM":{ "name":"CreateTokenWithIAM", @@ -60,7 +62,7 @@ {"shape":"InternalServerException"}, {"shape":"InvalidRequestRegionException"} ], - "documentation":"<p>Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM entities. The access token can be used to fetch short-term credentials for the assigned Amazon Web Services accounts or to access application APIs using <code>bearer</code> authentication.</p>" + "documentation":"<p>Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM entities. The access token can be used to fetch short-lived credentials for the assigned Amazon Web Services accounts or to access application APIs using <code>bearer</code> authentication.</p>" }, "RegisterClient":{ "name":"RegisterClient", @@ -78,8 +80,9 @@ {"shape":"InvalidRedirectUriException"}, {"shape":"UnsupportedGrantTypeException"} ], - "documentation":"<p>Registers a client with IAM Identity Center. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.</p>", - "authtype":"none" + "documentation":"<p>Registers a public client with IAM Identity Center. This allows clients to perform authorization using the authorization code grant with Proof Key for Code Exchange (PKCE) or the device code grant.</p>", + "authtype":"none", + "auth":["smithy.api#noAuth"] }, "StartDeviceAuthorization":{ "name":"StartDeviceAuthorization", @@ -97,7 +100,8 @@ {"shape":"InternalServerException"} ], "documentation":"<p>Initiates device authorization by requesting a pair of verification codes from the authorization service.</p>", - "authtype":"none" + "authtype":"none", + "auth":["smithy.api#noAuth"] } }, "shapes":{ @@ -172,19 +176,19 @@ }, "grantType":{ "shape":"GrantType", - "documentation":"<p>Supports the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:</p> <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code> </p> <p>* Refresh Token - <code>refresh_token</code> </p> <p>For information about how to obtain the device code, see the <a>StartDeviceAuthorization</a> topic.</p>" + "documentation":"<p>Supports the following OAuth grant types: Authorization Code, Device Code, and Refresh Token. Specify one of the following values, depending on the grant type that you want:</p> <p>* Authorization Code - <code>authorization_code</code> </p> <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code> </p> <p>* Refresh Token - <code>refresh_token</code> </p>" }, "deviceCode":{ "shape":"DeviceCode", - "documentation":"<p>Used only when calling this API for the Device Code grant type. This short-term code is used to identify this authorization request. This comes from the result of the <a>StartDeviceAuthorization</a> API.</p>" + "documentation":"<p>Used only when calling this API for the Device Code grant type. This short-lived code is used to identify this authorization request. This comes from the result of the <a>StartDeviceAuthorization</a> API.</p>" }, "code":{ "shape":"AuthCode", - "documentation":"<p>Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the <a>CreateToken</a> API.</p>" + "documentation":"<p>Used only when calling this API for the Authorization Code grant type. The short-lived code is used to identify this authorization request.</p>" }, "refreshToken":{ "shape":"RefreshToken", - "documentation":"<p>Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.</p> <p>For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html\">IAM Identity Center OIDC API Reference</a>.</p>" + "documentation":"<p>Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived tokens, such as the access token, that might expire.</p> <p>For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html\">IAM Identity Center OIDC API Reference</a>.</p>" }, "scope":{ "shape":"Scopes", @@ -242,11 +246,11 @@ }, "code":{ "shape":"AuthCode", - "documentation":"<p>Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.</p>" + "documentation":"<p>Used only when calling this API for the Authorization Code grant type. This short-lived code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.</p>" }, "refreshToken":{ "shape":"RefreshToken", - "documentation":"<p>Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.</p> <p>For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html\">IAM Identity Center OIDC API Reference</a>.</p>" + "documentation":"<p>Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-lived tokens, such as the access token, that might expire.</p> <p>For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html\">IAM Identity Center OIDC API Reference</a>.</p>" }, "assertion":{ "shape":"Assertion", @@ -514,7 +518,7 @@ }, "grantTypes":{ "shape":"GrantTypes", - "documentation":"<p>The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client.</p>" + "documentation":"<p>The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client. Supports the following OAuth 2.0 grant types: Authorization Code, Device Code, and Refresh Token. </p> <p>* Authorization Code - <code>authorization_code</code> </p> <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code> </p> <p>* Refresh Token - <code>refresh_token</code> </p>" }, "issuerUrl":{ "shape":"URI", @@ -668,5 +672,5 @@ }, "UserCode":{"type":"string"} }, - "documentation":"<p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a native application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with IAM Identity Center.</p> <note> <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p> </note> <p> <b>Considerations for Using This Guide</b> </p> <p>Before you begin using this guide, we recommend that you first review the following important information about how the IAM Identity Center OIDC service works.</p> <ul> <li> <p>The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization Grant standard (<a href=\"https://tools.ietf.org/html/rfc8628\">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single sign-on authentication with the CLI. </p> </li> <li> <p>With older versions of the CLI, the service only emits OIDC access tokens, so to obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that supports token refresh and doesn’t require re-authentication, update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and configurable IAM Identity Center session durations. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html\">Configure Amazon Web Services access portal session duration </a>. </p> </li> <li> <p>The access tokens provided by this service grant access to all Amazon Web Services account entitlements assigned to an IAM Identity Center user, not just a particular application.</p> </li> <li> <p>The documentation in this guide does not describe the mechanism to convert the access token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service endpoints. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html\">GetRoleCredentials</a> in the <i>IAM Identity Center Portal API Reference Guide</i>.</p> </li> </ul> <p>For general information about IAM Identity Center, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html\">What is IAM Identity Center?</a> in the <i>IAM Identity Center User Guide</i>.</p>" + "documentation":"<p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a native application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with IAM Identity Center.</p> <p> <b>API namespaces</b> </p> <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center OpenID Connect uses the <code>sso-oidc</code> namespace.</p> <p> <b>Considerations for using this guide</b> </p> <p>Before you begin using this guide, we recommend that you first review the following important information about how the IAM Identity Center OIDC service works.</p> <ul> <li> <p>The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization Grant standard (<a href=\"https://tools.ietf.org/html/rfc8628\">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single sign-on authentication with the CLI. </p> </li> <li> <p>With older versions of the CLI, the service only emits OIDC access tokens, so to obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that supports token refresh and doesn’t require re-authentication, update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and configurable IAM Identity Center session durations. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html\">Configure Amazon Web Services access portal session duration </a>. </p> </li> <li> <p>The access tokens provided by this service grant access to all Amazon Web Services account entitlements assigned to an IAM Identity Center user, not just a particular application.</p> </li> <li> <p>The documentation in this guide does not describe the mechanism to convert the access token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service endpoints. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html\">GetRoleCredentials</a> in the <i>IAM Identity Center Portal API Reference Guide</i>.</p> </li> </ul> <p>For general information about IAM Identity Center, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html\">What is IAM Identity Center?</a> in the <i>IAM Identity Center User Guide</i>.</p>" } diff --git a/contrib/python/botocore/py3/botocore/data/storagegateway/2013-06-30/service-2.json b/contrib/python/botocore/py3/botocore/data/storagegateway/2013-06-30/service-2.json index 38bd680a292..7b150485c95 100644 --- a/contrib/python/botocore/py3/botocore/data/storagegateway/2013-06-30/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/storagegateway/2013-06-30/service-2.json @@ -140,6 +140,20 @@ ], "documentation":"<p>Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.</p>" }, + "CancelCacheReport":{ + "name":"CancelCacheReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelCacheReportInput"}, + "output":{"shape":"CancelCacheReportOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"<p>Cancels generation of a specified cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error.</p>" + }, "CancelRetrieval":{ "name":"CancelRetrieval", "http":{ @@ -310,6 +324,20 @@ ], "documentation":"<p>Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request. This operation is supported only for the stored volume, cached volume, and tape gateway types.</p>" }, + "DeleteCacheReport":{ + "name":"DeleteCacheReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCacheReportInput"}, + "output":{"shape":"DeleteCacheReportOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"<p>Deletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use <code>CancelCacheReport</code> to cancel an IN-PROGRESS report.</p> <note> <p> <code>DeleteCacheReport</code> does not delete the report object from your Amazon S3 bucket.</p> </note>" + }, "DeleteChapCredentials":{ "name":"DeleteChapCredentials", "http":{ @@ -478,6 +506,20 @@ ], "documentation":"<p>Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape, and file gateway types.</p> <p>The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.</p>" }, + "DescribeCacheReport":{ + "name":"DescribeCacheReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCacheReportInput"}, + "output":{"shape":"DescribeCacheReportOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"<p>Returns information about the specified cache report, including completion status and generation progress.</p>" + }, "DescribeCachediSCSIVolumes":{ "name":"DescribeCachediSCSIVolumes", "http":{ @@ -772,6 +814,20 @@ ], "documentation":"<p>Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.</p> <p>This operation is only supported for tape gateways.</p>" }, + "ListCacheReports":{ + "name":"ListCacheReports", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCacheReportsInput"}, + "output":{"shape":"ListCacheReportsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"<p>Returns a list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the <code>DescribeCacheReport</code> action, such as report name, status, completion progress, start time, end time, filters, and tags.</p>" + }, "ListFileShares":{ "name":"ListFileShares", "http":{ @@ -924,7 +980,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"<p>Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.</p> <p>Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification\">Getting file upload notification</a> in the <i>Amazon S3 File Gateway User Guide</i>.</p>" + "documentation":"<p>Sends you notification through Amazon EventBridge when all files written to your file share have been uploaded to Amazon S3.</p> <p>Storage Gateway can send a notification through Amazon EventBridge when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through EventBridge. You can configure EventBridge to send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/filegateway/latest/files3/monitoring-file-gateway.html#get-notification\">Getting file upload notification</a> in the <i>Amazon S3 File Gateway User Guide</i>.</p>" }, "RefreshCache":{ "name":"RefreshCache", @@ -1052,6 +1108,20 @@ ], "documentation":"<p>Start a test that verifies that the specified gateway is configured for High Availability monitoring in your host environment. This request only initiates the test and that a successful response only indicates that the test was started. It doesn't indicate that the test passed. For the status of the test, invoke the <code>DescribeAvailabilityMonitorTest</code> API.</p> <note> <p>Starting this test will cause your gateway to go offline for a brief period.</p> </note>" }, + "StartCacheReport":{ + "name":"StartCacheReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartCacheReportInput"}, + "output":{"shape":"StartCacheReportOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"<p>Starts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share. You can use this report to identify and resolve issues if you have files failing upload from your gateway to Amazon S3. The report is a CSV file containing a list of files which match the set of filter parameters you specify in the request.</p> <note> <p>The <b>Files Failing Upload</b> flag is reset every 24 hours and during gateway reboot. If this report captures the files after the reset, but before they become flagged again, they will not be reported as <b>Files Failing Upload</b>.</p> </note> <p>The following requirements must be met to successfully generate a cache report:</p> <ul> <li> <p>You must have permissions to list the entire Amazon S3 bucket associated with the specified file share.</p> </li> <li> <p>No other cache reports can currently be in-progress for the specified file share.</p> </li> <li> <p>There must be fewer than 10 existing cache reports for the specified file share.</p> </li> <li> <p>The gateway must be online and connected to Amazon Web Services.</p> </li> <li> <p>The root disk must have at least 20GB of free space when report generation starts.</p> </li> <li> <p>You must specify at least one value for <code>InclusionFilters</code> or <code>ExclusionFilters</code> in the request.</p> </li> </ul>" + }, "StartGateway":{ "name":"StartGateway", "http":{ @@ -1711,6 +1781,116 @@ }, "documentation":"<p>The refresh cache information for the file share or FSx file systems.</p>" }, + "CacheReportARN":{ + "type":"string", + "max":500, + "min":50 + }, + "CacheReportFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"CacheReportFilterName", + "documentation":"<p>The parameter name for a filter that determines which files are included or excluded from a cache report.</p> <p> <b>Valid Names:</b> </p> <p>UploadFailureReason | UploadState</p>" + }, + "Values":{ + "shape":"CacheReportFilterValues", + "documentation":"<p>The parameter value for a filter that determines which files are included or excluded from a cache report.</p> <p> <b>Valid <code>UploadFailureReason</code> Values:</b> </p> <p> <code>InaccessibleStorageClass</code> | <code>InvalidObjectState</code> | <code>ObjectMissing</code> | <code>S3AccessDenied</code> </p> <p> <b>Valid <code>UploadState</code> Values:</b> </p> <p> <code>FailingUpload</code> </p>" + } + }, + "documentation":"<p>A list of filter parameters and associated values that determine which files are included or excluded from a cache report created by a <code>StartCacheReport</code> request. Multiple instances of the same filter parameter are combined with an OR operation, while different parameters are combined with an AND operation.</p>" + }, + "CacheReportFilterList":{ + "type":"list", + "member":{"shape":"CacheReportFilter"} + }, + "CacheReportFilterName":{ + "type":"string", + "enum":[ + "UploadState", + "UploadFailureReason" + ] + }, + "CacheReportFilterValue":{ + "type":"string", + "max":25, + "min":1 + }, + "CacheReportFilterValues":{ + "type":"list", + "member":{"shape":"CacheReportFilterValue"} + }, + "CacheReportInfo":{ + "type":"structure", + "members":{ + "CacheReportARN":{ + "shape":"CacheReportARN", + "documentation":"<p>The Amazon Resource Name (ARN) of the cache report you want to describe.</p>" + }, + "CacheReportStatus":{ + "shape":"CacheReportStatus", + "documentation":"<p>The status of the specified cache report.</p>" + }, + "ReportCompletionPercent":{ + "shape":"ReportCompletionPercent", + "documentation":"<p>The percentage of the report generation process that has been completed at time of inquiry.</p>" + }, + "EndTime":{ + "shape":"Time", + "documentation":"<p>The time at which the gateway stopped generating the cache report.</p>" + }, + "Role":{"shape":"Role"}, + "FileShareARN":{"shape":"FileShareARN"}, + "LocationARN":{ + "shape":"LocationARN", + "documentation":"<p>The ARN of the Amazon S3 bucket location where the cache report is saved.</p>" + }, + "StartTime":{ + "shape":"Time", + "documentation":"<p>The time at which the gateway started generating the cache report.</p>" + }, + "InclusionFilters":{ + "shape":"CacheReportFilterList", + "documentation":"<p>The list of filters and parameters that determine which files are included in the report.</p>" + }, + "ExclusionFilters":{ + "shape":"CacheReportFilterList", + "documentation":"<p>The list of filters and parameters that determine which files are excluded from the report.</p>" + }, + "ReportName":{ + "shape":"CacheReportName", + "documentation":"<p>The file name of the completed cache report object stored in Amazon S3.</p>" + }, + "Tags":{ + "shape":"Tags", + "documentation":"<p>The list of key/value tags associated with the report.</p>" + } + }, + "documentation":"<p>Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.</p>" + }, + "CacheReportList":{ + "type":"list", + "member":{"shape":"CacheReportInfo"} + }, + "CacheReportName":{ + "type":"string", + "max":100, + "min":1 + }, + "CacheReportStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETED", + "CANCELED", + "FAILED", + "ERROR" + ] + }, "CacheStaleTimeoutInSeconds":{"type":"integer"}, "CachediSCSIVolume":{ "type":"structure", @@ -1796,6 +1976,25 @@ }, "documentation":"<p>CancelArchivalOutput</p>" }, + "CancelCacheReportInput":{ + "type":"structure", + "required":["CacheReportARN"], + "members":{ + "CacheReportARN":{ + "shape":"CacheReportARN", + "documentation":"<p>The Amazon Resource Name (ARN) of the cache report you want to cancel.</p>" + } + } + }, + "CancelCacheReportOutput":{ + "type":"structure", + "members":{ + "CacheReportARN":{ + "shape":"CacheReportARN", + "documentation":"<p>The Amazon Resource Name (ARN) of the cache report you want to cancel.</p>" + } + } + }, "CancelRetrievalInput":{ "type":"structure", "required":[ @@ -2525,6 +2724,25 @@ }, "documentation":"<p>A JSON object containing the Amazon Resource Name (ARN) of the gateway whose bandwidth rate information was deleted.</p>" }, + "DeleteCacheReportInput":{ + "type":"structure", + "required":["CacheReportARN"], + "members":{ + "CacheReportARN":{ + "shape":"CacheReportARN", + "documentation":"<p>The Amazon Resource Name (ARN) of the cache report you want to delete.</p>" + } + } + }, + "DeleteCacheReportOutput":{ + "type":"structure", + "members":{ + "CacheReportARN":{ + "shape":"CacheReportARN", + "documentation":"<p>The Amazon Resource Name (ARN) of the cache report you want to delete.</p>" + } + } + }, "DeleteChapCredentialsInput":{ "type":"structure", "required":[ @@ -2816,6 +3034,25 @@ } } }, + "DescribeCacheReportInput":{ + "type":"structure", + "required":["CacheReportARN"], + "members":{ + "CacheReportARN":{ + "shape":"CacheReportARN", + "documentation":"<p>The Amazon Resource Name (ARN) of the cache report you want to describe.</p>" + } + } + }, + "DescribeCacheReportOutput":{ + "type":"structure", + "members":{ + "CacheReportInfo":{ + "shape":"CacheReportInfo", + "documentation":"<p>Contains all informational fields associated with a cache report. Includes name, ARN, tags, status, progress, filters, start time, and end time.</p>" + } + } + }, "DescribeCachediSCSIVolumesInput":{ "type":"structure", "required":["VolumeARNs"], @@ -3073,7 +3310,7 @@ }, "ActiveDirectoryStatus":{ "shape":"ActiveDirectoryStatus", - "documentation":"<p>Indicates the status of a gateway that is a member of the Active Directory domain.</p> <ul> <li> <p> <code>ACCESS_DENIED</code>: Indicates that the <code>JoinDomain</code> operation failed due to an authentication error.</p> </li> <li> <p> <code>DETACHED</code>: Indicates that gateway is not joined to a domain.</p> </li> <li> <p> <code>JOINED</code>: Indicates that the gateway has successfully joined a domain.</p> </li> <li> <p> <code>JOINING</code>: Indicates that a <code>JoinDomain</code> operation is in progress.</p> </li> <li> <p> <code>NETWORK_ERROR</code>: Indicates that <code>JoinDomain</code> operation failed due to a network or connectivity error.</p> </li> <li> <p> <code>TIMEOUT</code>: Indicates that the <code>JoinDomain</code> operation failed because the operation didn't complete within the allotted time.</p> </li> <li> <p> <code>UNKNOWN_ERROR</code>: Indicates that the <code>JoinDomain</code> operation failed due to another type of error.</p> </li> </ul>" + "documentation":"<p>Indicates the status of a gateway that is a member of the Active Directory domain.</p> <note> <p>This field is only used as part of a <code>JoinDomain</code> request. It is not affected by Active Directory connectivity changes that occur after the <code>JoinDomain</code> request succeeds.</p> </note> <ul> <li> <p> <code>ACCESS_DENIED</code>: Indicates that the <code>JoinDomain</code> operation failed due to an authentication error.</p> </li> <li> <p> <code>DETACHED</code>: Indicates that gateway is not joined to a domain.</p> </li> <li> <p> <code>JOINED</code>: Indicates that the gateway has successfully joined a domain.</p> </li> <li> <p> <code>JOINING</code>: Indicates that a <code>JoinDomain</code> operation is in progress.</p> </li> <li> <p> <code>NETWORK_ERROR</code>: Indicates that <code>JoinDomain</code> operation failed due to a network or connectivity error.</p> </li> <li> <p> <code>TIMEOUT</code>: Indicates that the <code>JoinDomain</code> operation failed because the operation didn't complete within the allotted time.</p> </li> <li> <p> <code>UNKNOWN_ERROR</code>: Indicates that the <code>JoinDomain</code> operation failed due to another type of error.</p> </li> </ul>" }, "SMBGuestPasswordSet":{ "shape":"Boolean", @@ -4029,7 +4266,7 @@ }, "ActiveDirectoryStatus":{ "shape":"ActiveDirectoryStatus", - "documentation":"<p>Indicates the status of the gateway as a member of the Active Directory domain.</p> <ul> <li> <p> <code>ACCESS_DENIED</code>: Indicates that the <code>JoinDomain</code> operation failed due to an authentication error.</p> </li> <li> <p> <code>DETACHED</code>: Indicates that gateway is not joined to a domain.</p> </li> <li> <p> <code>JOINED</code>: Indicates that the gateway has successfully joined a domain.</p> </li> <li> <p> <code>JOINING</code>: Indicates that a <code>JoinDomain</code> operation is in progress.</p> </li> <li> <p> <code>NETWORK_ERROR</code>: Indicates that <code>JoinDomain</code> operation failed due to a network or connectivity error.</p> </li> <li> <p> <code>TIMEOUT</code>: Indicates that the <code>JoinDomain</code> operation failed because the operation didn't complete within the allotted time.</p> </li> <li> <p> <code>UNKNOWN_ERROR</code>: Indicates that the <code>JoinDomain</code> operation failed due to another type of error.</p> </li> </ul>" + "documentation":"<p>Indicates the status of the gateway as a member of the Active Directory domain.</p> <note> <p>This field is only used as part of a <code>JoinDomain</code> request. It is not affected by Active Directory connectivity changes that occur after the <code>JoinDomain</code> request succeeds.</p> </note> <ul> <li> <p> <code>ACCESS_DENIED</code>: Indicates that the <code>JoinDomain</code> operation failed due to an authentication error.</p> </li> <li> <p> <code>DETACHED</code>: Indicates that gateway is not joined to a domain.</p> </li> <li> <p> <code>JOINED</code>: Indicates that the gateway has successfully joined a domain.</p> </li> <li> <p> <code>JOINING</code>: Indicates that a <code>JoinDomain</code> operation is in progress.</p> </li> <li> <p> <code>NETWORK_ERROR</code>: Indicates that <code>JoinDomain</code> operation failed due to a network or connectivity error.</p> </li> <li> <p> <code>TIMEOUT</code>: Indicates that the <code>JoinDomain</code> operation failed because the operation didn't complete within the allotted time.</p> </li> <li> <p> <code>UNKNOWN_ERROR</code>: Indicates that the <code>JoinDomain</code> operation failed due to another type of error.</p> </li> </ul>" } }, "documentation":"<p>JoinDomainOutput</p>" @@ -4061,6 +4298,28 @@ } } }, + "ListCacheReportsInput":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"Marker", + "documentation":"<p>Opaque pagination token returned from a previous <code>ListCacheReports</code> operation. If present, <code>Marker</code> specifies where to continue the list from after a previous call to <code>ListCacheReports</code>. Optional.</p>" + } + } + }, + "ListCacheReportsOutput":{ + "type":"structure", + "members":{ + "CacheReportList":{ + "shape":"CacheReportList", + "documentation":"<p>A list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the <code>DescribeCacheReport</code> action, such as report status, completion progress, start time, end time, filters, and tags.</p>" + }, + "Marker":{ + "shape":"Marker", + "documentation":"<p>If the request includes <code>Marker</code>, the response returns that value in this field.</p>" + } + } + }, "ListFileSharesInput":{ "type":"structure", "members":{ @@ -4687,6 +4946,11 @@ }, "documentation":"<p>RemoveTagsFromResourceOutput</p>" }, + "ReportCompletionPercent":{ + "type":"integer", + "max":100, + "min":0 + }, "ResetCacheInput":{ "type":"structure", "required":["GatewayARN"], @@ -5028,6 +5292,60 @@ "GatewayARN":{"shape":"GatewayARN"} } }, + "StartCacheReportInput":{ + "type":"structure", + "required":[ + "FileShareARN", + "Role", + "LocationARN", + "BucketRegion", + "ClientToken" + ], + "members":{ + "FileShareARN":{"shape":"FileShareARN"}, + "Role":{ + "shape":"Role", + "documentation":"<p>The ARN of the IAM role used when saving the cache report to Amazon S3.</p>" + }, + "LocationARN":{ + "shape":"LocationARN", + "documentation":"<p>The ARN of the Amazon S3 bucket where the cache report will be saved.</p> <note> <p>We do not recommend saving the cache report to the same Amazon S3 bucket for which you are generating the report.</p> <p>This field does not accept access point ARNs.</p> </note>" + }, + "BucketRegion":{ + "shape":"RegionId", + "documentation":"<p>The Amazon Web Services Region of the Amazon S3 bucket associated with the file share for which you want to generate the cache report.</p>" + }, + "VPCEndpointDNSName":{ + "shape":"DNSHostName", + "documentation":"<p>The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional.</p>" + }, + "InclusionFilters":{ + "shape":"CacheReportFilterList", + "documentation":"<p>The list of filters and parameters that determine which files are included in the report. You must specify at least one value for <code>InclusionFilters</code> or <code>ExclusionFilters</code> in a <code>StartCacheReport</code> request.</p>" + }, + "ExclusionFilters":{ + "shape":"CacheReportFilterList", + "documentation":"<p>The list of filters and parameters that determine which files are excluded from the report. You must specify at least one value for <code>InclusionFilters</code> or <code>ExclusionFilters</code> in a <code>StartCacheReport</code> request.</p>" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"<p>A unique identifier that you use to ensure idempotent report generation if you need to retry an unsuccessful <code>StartCacheReport</code> request. If you retry a request, use the same <code>ClientToken</code> you specified in the initial request.</p>" + }, + "Tags":{ + "shape":"Tags", + "documentation":"<p>A list of up to 50 key/value tags that you can assign to the cache report. Using tags can help you categorize your reports and more easily locate them in search results.</p>" + } + } + }, + "StartCacheReportOutput":{ + "type":"structure", + "members":{ + "CacheReportARN":{ + "shape":"CacheReportARN", + "documentation":"<p>The Amazon Resource Name (ARN) of the cache report generated by the <code>StartCacheReport</code> request.</p>" + } + } + }, "StartGatewayInput":{ "type":"structure", "required":["GatewayARN"], diff --git a/contrib/python/botocore/py3/botocore/data/timestream-influxdb/2023-01-27/paginators-1.json b/contrib/python/botocore/py3/botocore/data/timestream-influxdb/2023-01-27/paginators-1.json index 999388e1555..e0b4f3c57b6 100644 --- a/contrib/python/botocore/py3/botocore/data/timestream-influxdb/2023-01-27/paginators-1.json +++ b/contrib/python/botocore/py3/botocore/data/timestream-influxdb/2023-01-27/paginators-1.json @@ -11,6 +11,18 @@ "output_token": "nextToken", "limit_key": "maxResults", "result_key": "items" + }, + "ListDbClusters": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" + }, + "ListDbInstancesForCluster": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "items" } } } diff --git a/contrib/python/botocore/py3/botocore/data/timestream-influxdb/2023-01-27/service-2.json b/contrib/python/botocore/py3/botocore/data/timestream-influxdb/2023-01-27/service-2.json index c95a7644c7e..5eb74e9ff2c 100644 --- a/contrib/python/botocore/py3/botocore/data/timestream-influxdb/2023-01-27/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/timestream-influxdb/2023-01-27/service-2.json @@ -15,6 +15,26 @@ "uid":"timestream-influxdb-2023-01-27" }, "operations":{ + "CreateDbCluster":{ + "name":"CreateDbCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDbClusterInput"}, + "output":{"shape":"CreateDbClusterOutput"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Creates a new Timestream for InfluxDB cluster.</p>", + "idempotent":true + }, "CreateDbInstance":{ "name":"CreateDbInstance", "http":{ @@ -55,6 +75,25 @@ "documentation":"<p>Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.</p>", "idempotent":true }, + "DeleteDbCluster":{ + "name":"DeleteDbCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDbClusterInput"}, + "output":{"shape":"DeleteDbClusterOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Deletes a Timestream for InfluxDB cluster.</p>", + "idempotent":true + }, "DeleteDbInstance":{ "name":"DeleteDbInstance", "http":{ @@ -74,6 +113,23 @@ "documentation":"<p>Deletes a Timestream for InfluxDB DB instance.</p>", "idempotent":true }, + "GetDbCluster":{ + "name":"GetDbCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDbClusterInput"}, + "output":{"shape":"GetDbClusterOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Retrieves information about a Timestream for InfluxDB cluster.</p>" + }, "GetDbInstance":{ "name":"GetDbInstance", "http":{ @@ -108,6 +164,23 @@ ], "documentation":"<p>Returns a Timestream for InfluxDB DB parameter group.</p>" }, + "ListDbClusters":{ + "name":"ListDbClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDbClustersInput"}, + "output":{"shape":"ListDbClustersOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Returns a list of Timestream for InfluxDB DB clusters.</p>" + }, "ListDbInstances":{ "name":"ListDbInstances", "http":{ @@ -125,6 +198,23 @@ ], "documentation":"<p>Returns a list of Timestream for InfluxDB DB instances.</p>" }, + "ListDbInstancesForCluster":{ + "name":"ListDbInstancesForCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDbInstancesForClusterInput"}, + "output":{"shape":"ListDbInstancesForClusterOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Returns a list of Timestream for InfluxDB clusters.</p>" + }, "ListDbParameterGroups":{ "name":"ListDbParameterGroups", "http":{ @@ -182,6 +272,25 @@ "documentation":"<p>Removes the tag from the specified resource.</p>", "idempotent":true }, + "UpdateDbCluster":{ + "name":"UpdateDbCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDbClusterInput"}, + "output":{"shape":"UpdateDbClusterOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"<p>Updates a Timestream for InfluxDB cluster.</p>", + "idempotent":true + }, "UpdateDbInstance":{ "name":"UpdateDbInstance", "http":{ @@ -215,14 +324,14 @@ "AllocatedStorage":{ "type":"integer", "box":true, - "max":16384, + "max":15360, "min":20 }, "Arn":{ "type":"string", "max":1011, "min":1, - "pattern":"arn:aws[a-z\\-]*:timestream\\-influxdb:[a-z0-9\\-]+:[0-9]{12}:(db\\-instance|db\\-parameter\\-group)/[a-zA-Z0-9]{3,64}" + "pattern":"arn:aws[a-z\\-]*:timestream\\-influxdb:[a-z0-9\\-]+:[0-9]{12}:(db\\-instance|db\\-cluster|db\\-parameter\\-group)/[a-zA-Z0-9]{3,64}" }, "Boolean":{ "type":"boolean", @@ -234,6 +343,21 @@ "min":2, "pattern":"[^_\"][^\"]*" }, + "ClusterDeploymentType":{ + "type":"string", + "enum":["MULTI_NODE_READ_REPLICAS"] + }, + "ClusterStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "AVAILABLE", + "FAILED", + "DELETED" + ] + }, "ConflictException":{ "type":"structure", "required":[ @@ -255,6 +379,105 @@ "documentation":"<p>The request conflicts with an existing resource in Timestream for InfluxDB.</p>", "exception":true }, + "CreateDbClusterInput":{ + "type":"structure", + "required":[ + "name", + "password", + "dbInstanceType", + "allocatedStorage", + "vpcSubnetIds", + "vpcSecurityGroupIds", + "deploymentType" + ], + "members":{ + "name":{ + "shape":"DbClusterName", + "documentation":"<p>The name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB cluster names must be unique per customer and per region.</p>" + }, + "username":{ + "shape":"Username", + "documentation":"<p>The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in Amazon Web Services Secrets Manager in your account.</p>" + }, + "password":{ + "shape":"Password", + "documentation":"<p>The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in Amazon Web Services Secrets Manager in your account.</p>" + }, + "organization":{ + "shape":"Organization", + "documentation":"<p>The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.</p>" + }, + "bucket":{ + "shape":"Bucket", + "documentation":"<p>The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.</p>" + }, + "port":{ + "shape":"Port", + "documentation":"<p>The port number on which InfluxDB accepts connections.</p> <p>Valid Values: 1024-65535</p> <p>Default: 8086</p> <p>Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680</p>" + }, + "dbParameterGroupIdentifier":{ + "shape":"DbParameterGroupIdentifier", + "documentation":"<p>The ID of the DB parameter group to assign to your DB cluster. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.</p>" + }, + "dbInstanceType":{ + "shape":"DbInstanceType", + "documentation":"<p>The Timestream for InfluxDB DB instance type to run InfluxDB on.</p>" + }, + "dbStorageType":{ + "shape":"DbStorageType", + "documentation":"<p>The Timestream for InfluxDB DB storage type to read and write InfluxDB data.</p> <p>You can choose between three different types of provisioned Influx IOPS Included storage according to your workload requirements:</p> <ul> <li> <p>Influx I/O Included 3000 IOPS</p> </li> <li> <p>Influx I/O Included 12000 IOPS</p> </li> <li> <p>Influx I/O Included 16000 IOPS</p> </li> </ul>" + }, + "allocatedStorage":{ + "shape":"AllocatedStorage", + "documentation":"<p>The amount of storage to allocate for your DB storage type in GiB (gibibytes).</p>" + }, + "networkType":{ + "shape":"NetworkType", + "documentation":"<p>Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>" + }, + "publiclyAccessible":{ + "shape":"Boolean", + "documentation":"<p>Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.</p>" + }, + "vpcSubnetIds":{ + "shape":"VpcSubnetIdList", + "documentation":"<p>A list of VPC subnet IDs to associate with the DB cluster. Provide at least two VPC subnet IDs in different Availability Zones when deploying with a Multi-AZ standby.</p>" + }, + "vpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"<p>A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.</p>" + }, + "deploymentType":{ + "shape":"ClusterDeploymentType", + "documentation":"<p>Specifies the type of cluster to create.</p>" + }, + "failoverMode":{ + "shape":"FailoverMode", + "documentation":"<p>Specifies the behavior of failure recovery when the primary node of the cluster fails.</p>" + }, + "logDeliveryConfiguration":{ + "shape":"LogDeliveryConfiguration", + "documentation":"<p>Configuration for sending InfluxDB engine logs to a specified S3 bucket.</p>" + }, + "tags":{ + "shape":"RequestTagMap", + "documentation":"<p>A list of key-value pairs to associate with the DB instance.</p>" + } + } + }, + "CreateDbClusterOutput":{ + "type":"structure", + "members":{ + "dbClusterId":{ + "shape":"DbClusterId", + "documentation":"<p>A service-generated unique identifier.</p>" + }, + "dbClusterStatus":{ + "shape":"ClusterStatus", + "documentation":"<p>The status of the DB cluster.</p>" + } + } + }, "CreateDbInstanceInput":{ "type":"structure", "required":[ @@ -420,6 +643,14 @@ "influxAuthParametersSecretArn":{ "shape":"String", "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.</p>" + }, + "dbClusterId":{ + "shape":"DbClusterId", + "documentation":"<p>Specifies the DbCluster to which this DbInstance belongs to.</p>" + }, + "instanceMode":{ + "shape":"InstanceMode", + "documentation":"<p>Specifies the DbInstance's role in the cluster.</p>" } } }, @@ -480,6 +711,144 @@ } } }, + "DbClusterId":{ + "type":"string", + "max":64, + "min":3, + "pattern":"[a-zA-Z0-9]+" + }, + "DbClusterName":{ + "type":"string", + "max":40, + "min":3, + "pattern":"[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*" + }, + "DbClusterSummary":{ + "type":"structure", + "required":[ + "id", + "name", + "arn" + ], + "members":{ + "id":{ + "shape":"DbClusterId", + "documentation":"<p>Service-generated unique identifier of the DB cluster to retrieve.</p>" + }, + "name":{ + "shape":"DbClusterName", + "documentation":"<p>Customer supplied name of the Timestream for InfluxDB cluster.</p>" + }, + "arn":{ + "shape":"Arn", + "documentation":"<p>The Amazon Resource Name (ARN) of the DB cluster.</p>" + }, + "status":{ + "shape":"ClusterStatus", + "documentation":"<p>The status of the DB cluster.</p>" + }, + "endpoint":{ + "shape":"String", + "documentation":"<p>The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.</p>" + }, + "readerEndpoint":{ + "shape":"String", + "documentation":"<p>The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.</p>" + }, + "port":{ + "shape":"Port", + "documentation":"<p>The port number on which InfluxDB accepts connections.</p>" + }, + "deploymentType":{ + "shape":"ClusterDeploymentType", + "documentation":"<p>Deployment type of the DB cluster</p>" + }, + "dbInstanceType":{ + "shape":"DbInstanceType", + "documentation":"<p>The Timestream for InfluxDB DB instance type that InfluxDB runs on.</p>" + }, + "networkType":{ + "shape":"NetworkType", + "documentation":"<p>Specifies whether the network type of the Timestream for InfluxDB Cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>" + }, + "dbStorageType":{ + "shape":"DbStorageType", + "documentation":"<p>The Timestream for InfluxDB DB storage type that InfluxDB stores data on.</p>" + }, + "allocatedStorage":{ + "shape":"AllocatedStorage", + "documentation":"<p>The amount of storage allocated for your DB storage type (in gibibytes).</p>" + } + }, + "documentation":"<p>Describes a summary of a Timestream for InfluxDB cluster.</p>" + }, + "DbClusterSummaryList":{ + "type":"list", + "member":{"shape":"DbClusterSummary"} + }, + "DbInstanceForClusterSummary":{ + "type":"structure", + "required":[ + "id", + "name", + "arn" + ], + "members":{ + "id":{ + "shape":"DbInstanceId", + "documentation":"<p>The service-generated unique identifier of the DB instance.</p>" + }, + "name":{ + "shape":"DbInstanceName", + "documentation":"<p>A service-generated name for the DB instance based on the customer-supplied name for the DB cluster.</p>" + }, + "arn":{ + "shape":"Arn", + "documentation":"<p>The Amazon Resource Name (ARN) of the DB instance.</p>" + }, + "status":{ + "shape":"Status", + "documentation":"<p>The status of the DB instance.</p>" + }, + "endpoint":{ + "shape":"String", + "documentation":"<p>The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.</p>" + }, + "port":{ + "shape":"Port", + "documentation":"<p>The port number on which InfluxDB accepts connections.</p>" + }, + "networkType":{ + "shape":"NetworkType", + "documentation":"<p>Specifies whether the network type of the Timestream for InfluxDB instance is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>" + }, + "dbInstanceType":{ + "shape":"DbInstanceType", + "documentation":"<p>The Timestream for InfluxDB instance type to run InfluxDB on.</p>" + }, + "dbStorageType":{ + "shape":"DbStorageType", + "documentation":"<p>The storage type for your DB instance.</p>" + }, + "allocatedStorage":{ + "shape":"AllocatedStorage", + "documentation":"<p>The amount of storage allocated for your DB storage type in GiB (gibibytes).</p>" + }, + "deploymentType":{ + "shape":"DeploymentType", + "documentation":"<p>Specifies the deployment type if applicable.</p>" + }, + "instanceMode":{ + "shape":"InstanceMode", + "documentation":"<p>Specifies the DB instance's role in the cluster.</p>" + } + }, + "documentation":"<p>Contains a summary of a DB instance belonging to a DB cluster.</p>" + }, + "DbInstanceForClusterSummaryList":{ + "type":"list", + "member":{"shape":"DbInstanceForClusterSummary"} + }, "DbInstanceId":{ "type":"string", "max":64, @@ -627,6 +996,25 @@ "InfluxIOIncludedT3" ] }, + "DeleteDbClusterInput":{ + "type":"structure", + "required":["dbClusterId"], + "members":{ + "dbClusterId":{ + "shape":"DbClusterId", + "documentation":"<p>Service-generated unique identifier of the DB cluster.</p>" + } + } + }, + "DeleteDbClusterOutput":{ + "type":"structure", + "members":{ + "dbClusterStatus":{ + "shape":"ClusterStatus", + "documentation":"<p>The status of the DB cluster.</p>" + } + } + }, "DeleteDbInstanceInput":{ "type":"structure", "required":["identifier"], @@ -721,6 +1109,14 @@ "influxAuthParametersSecretArn":{ "shape":"String", "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.</p>" + }, + "dbClusterId":{ + "shape":"DbClusterId", + "documentation":"<p>Specifies the DbCluster to which this DbInstance belongs to.</p>" + }, + "instanceMode":{ + "shape":"InstanceMode", + "documentation":"<p>Specifies the DbInstance's role in the cluster.</p>" } } }, @@ -763,6 +1159,109 @@ "box":true, "min":0 }, + "FailoverMode":{ + "type":"string", + "enum":[ + "AUTOMATIC", + "NO_FAILOVER" + ] + }, + "GetDbClusterInput":{ + "type":"structure", + "required":["dbClusterId"], + "members":{ + "dbClusterId":{ + "shape":"DbClusterId", + "documentation":"<p>Service-generated unique identifier of the DB cluster to retrieve.</p>" + } + } + }, + "GetDbClusterOutput":{ + "type":"structure", + "required":[ + "id", + "name", + "arn" + ], + "members":{ + "id":{ + "shape":"DbClusterId", + "documentation":"<p>Service-generated unique identifier of the DB cluster to retrieve.</p>" + }, + "name":{ + "shape":"DbClusterName", + "documentation":"<p>Customer-supplied name of the Timestream for InfluxDB cluster.</p>" + }, + "arn":{ + "shape":"Arn", + "documentation":"<p>The Amazon Resource Name (ARN) of the DB cluster.</p>" + }, + "status":{ + "shape":"ClusterStatus", + "documentation":"<p>The status of the DB cluster.</p>" + }, + "endpoint":{ + "shape":"String", + "documentation":"<p>The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.</p>" + }, + "readerEndpoint":{ + "shape":"String", + "documentation":"<p>The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.</p>" + }, + "port":{ + "shape":"Port", + "documentation":"<p>The port number on which InfluxDB accepts connections.</p>" + }, + "deploymentType":{ + "shape":"ClusterDeploymentType", + "documentation":"<p>Deployment type of the DB cluster.</p>" + }, + "dbInstanceType":{ + "shape":"DbInstanceType", + "documentation":"<p>The Timestream for InfluxDB instance type that InfluxDB runs on.</p>" + }, + "networkType":{ + "shape":"NetworkType", + "documentation":"<p>Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>" + }, + "dbStorageType":{ + "shape":"DbStorageType", + "documentation":"<p>The Timestream for InfluxDB DB storage type that InfluxDB stores data on.</p>" + }, + "allocatedStorage":{ + "shape":"AllocatedStorage", + "documentation":"<p>The amount of storage allocated for your DB storage type (in gibibytes).</p>" + }, + "publiclyAccessible":{ + "shape":"Boolean", + "documentation":"<p>Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.</p>" + }, + "dbParameterGroupIdentifier":{ + "shape":"DbParameterGroupIdentifier", + "documentation":"<p>The ID of the DB parameter group assigned to your DB cluster.</p>" + }, + "logDeliveryConfiguration":{ + "shape":"LogDeliveryConfiguration", + "documentation":"<p>Configuration for sending InfluxDB engine logs to send to specified S3 bucket.</p>" + }, + "influxAuthParametersSecretArn":{ + "shape":"String", + "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.</p>" + }, + "vpcSubnetIds":{ + "shape":"VpcSubnetIdList", + "documentation":"<p>A list of VPC subnet IDs associated with the DB cluster.</p>" + }, + "vpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"<p>A list of VPC security group IDs associated with the DB cluster.</p>" + }, + "failoverMode":{ + "shape":"FailoverMode", + "documentation":"<p>The configured failover mode for the DB cluster.</p>" + } + } + }, "GetDbInstanceInput":{ "type":"structure", "required":["identifier"], @@ -857,6 +1356,14 @@ "influxAuthParametersSecretArn":{ "shape":"String", "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.</p>" + }, + "dbClusterId":{ + "shape":"DbClusterId", + "documentation":"<p>Specifies the DbCluster to which this DbInstance belongs to.</p>" + }, + "instanceMode":{ + "shape":"InstanceMode", + "documentation":"<p>Specifies the DbInstance's role in the cluster.</p>" } } }, @@ -1144,6 +1651,14 @@ "max":256, "min":0 }, + "InstanceMode":{ + "type":"string", + "enum":[ + "PRIMARY", + "STANDBY", + "REPLICA" + ] + }, "Integer":{ "type":"integer", "box":true @@ -1159,6 +1674,65 @@ "fault":true, "retryable":{"throttling":false} }, + "ListDbClustersInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.</p>" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"<p>The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.</p>" + } + } + }, + "ListDbClustersOutput":{ + "type":"structure", + "required":["items"], + "members":{ + "items":{ + "shape":"DbClusterSummaryList", + "documentation":"<p>A list of Timestream for InfluxDB cluster summaries.</p>" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.</p>" + } + } + }, + "ListDbInstancesForClusterInput":{ + "type":"structure", + "required":["dbClusterId"], + "members":{ + "dbClusterId":{ + "shape":"DbClusterId", + "documentation":"<p>Service-generated unique identifier of the DB cluster.</p>" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.</p>" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"<p>The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.</p>" + } + } + }, + "ListDbInstancesForClusterOutput":{ + "type":"structure", + "required":["items"], + "members":{ + "items":{ + "shape":"DbInstanceForClusterSummaryList", + "documentation":"<p>A list of Timestream for InfluxDB instance summaries belonging to the cluster.</p>" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"<p>Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.</p>" + } + } + }, "ListDbInstancesInput":{ "type":"structure", "members":{ @@ -1451,6 +2025,45 @@ } } }, + "UpdateDbClusterInput":{ + "type":"structure", + "required":["dbClusterId"], + "members":{ + "dbClusterId":{ + "shape":"DbClusterId", + "documentation":"<p>Service-generated unique identifier of the DB cluster to update.</p>" + }, + "logDeliveryConfiguration":{ + "shape":"LogDeliveryConfiguration", + "documentation":"<p>The log delivery configuration to apply to the DB cluster.</p>" + }, + "dbParameterGroupIdentifier":{ + "shape":"DbParameterGroupIdentifier", + "documentation":"<p>Update the DB cluster to use the specified DB parameter group.</p>" + }, + "port":{ + "shape":"Port", + "documentation":"<p>Update the DB cluster to use the specified port.</p>" + }, + "dbInstanceType":{ + "shape":"DbInstanceType", + "documentation":"<p>Update the DB cluster to use the specified DB instance Type.</p>" + }, + "failoverMode":{ + "shape":"FailoverMode", + "documentation":"<p>Update the DB cluster's failover behavior.</p>" + } + } + }, + "UpdateDbClusterOutput":{ + "type":"structure", + "members":{ + "dbClusterStatus":{ + "shape":"ClusterStatus", + "documentation":"<p>The status of the DB cluster.</p>" + } + } + }, "UpdateDbInstanceInput":{ "type":"structure", "required":["identifier"], @@ -1478,6 +2091,14 @@ "deploymentType":{ "shape":"DeploymentType", "documentation":"<p>Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.</p>" + }, + "dbStorageType":{ + "shape":"DbStorageType", + "documentation":"<p>The Timestream for InfluxDB DB storage type that InfluxDB stores data on.</p>" + }, + "allocatedStorage":{ + "shape":"AllocatedStorage", + "documentation":"<p>The amount of storage to allocate for your DB storage type (in gibibytes).</p>" } } }, @@ -1565,6 +2186,14 @@ "influxAuthParametersSecretArn":{ "shape":"String", "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.</p>" + }, + "dbClusterId":{ + "shape":"DbClusterId", + "documentation":"<p>Specifies the DbCluster to which this DbInstance belongs to.</p>" + }, + "instanceMode":{ + "shape":"InstanceMode", + "documentation":"<p>Specifies the DbInstance's role in the cluster.</p>" } } }, diff --git a/contrib/python/botocore/py3/botocore/data/transcribe/2017-10-26/service-2.json b/contrib/python/botocore/py3/botocore/data/transcribe/2017-10-26/service-2.json index 45f7eb9efa6..cea5627dc29 100644 --- a/contrib/python/botocore/py3/botocore/data/transcribe/2017-10-26/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/transcribe/2017-10-26/service-2.json @@ -852,7 +852,7 @@ "ContentRedaction":{"shape":"ContentRedaction"}, "LanguageOptions":{ "shape":"LanguageOptions", - "documentation":"<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>Including language options can improve the accuracy of language identification.</p> <p>For a list of languages supported with Call Analytics, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a> table.</p> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file must be encoded at a sample rate of 16,000 Hz or higher.</p>" + "documentation":"<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>Including language options can improve the accuracy of language identification.</p> <p>For a list of languages supported with Call Analytics, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a> table.</p> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file must be encoded at a sample rate of 16,000 Hz or higher.</p>" }, "LanguageIdSettings":{ "shape":"LanguageIdSettingsMap", @@ -1010,6 +1010,16 @@ "max":1, "min":0 }, + "ClinicalNoteGenerationSettings":{ + "type":"structure", + "members":{ + "NoteTemplate":{ + "shape":"MedicalScribeNoteTemplate", + "documentation":"<p>Specify one of the following templates to use for the clinical note summary. The default is <code>HISTORY_AND_PHYSICAL</code>.</p> <ul> <li> <p>HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical documentation. Sections include Chief Complaint, History of Present Illness, Review of Systems, Past Medical History, Assessment, and Plan.</p> </li> <li> <p>GIRPP: Provides summaries based on the patients progress toward goals. Sections include Goal, Intervention, Response, Progress, and Plan.</p> </li> </ul>" + } + }, + "documentation":"<p>The output configuration for clinical note generation.</p>" + }, "ConflictException":{ "type":"structure", "members":{ @@ -2451,6 +2461,13 @@ "type":"string", "enum":["en-US"] }, + "MedicalScribeNoteTemplate":{ + "type":"string", + "enum":[ + "HISTORY_AND_PHYSICAL", + "GIRPP" + ] + }, "MedicalScribeOutput":{ "type":"structure", "required":[ @@ -2502,6 +2519,10 @@ "VocabularyFilterMethod":{ "shape":"VocabularyFilterMethod", "documentation":"<p>Specify how you want your custom vocabulary filter applied to your transcript.</p> <p>To replace words with <code>***</code>, choose <code>mask</code>.</p> <p>To delete words, choose <code>remove</code>.</p> <p>To flag words without changing them, choose <code>tag</code>.</p>" + }, + "ClinicalNoteGenerationSettings":{ + "shape":"ClinicalNoteGenerationSettings", + "documentation":"<p>Specify settings for the clinical note generation.</p>" } }, "documentation":"<p>Makes it possible to control how your Medical Scribe job is processed using a <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code> and <code>ChannelDefinitions</code> are not set. One and only one of <code>ChannelIdentification</code> and <code>ShowSpeakerLabels</code> must be set. If <code>ShowSpeakerLabels</code> is set, <code>MaxSpeakerLabels</code> must also be set. Use <code>Settings</code> to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>. <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set. </p>" @@ -3137,7 +3158,7 @@ }, "LanguageCode":{ "shape":"LanguageCode", - "documentation":"<p>The language code that represents the language spoken in the input media file.</p> <p>If you're unsure of the language spoken in your media file, consider using <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable automatic language identification.</p> <p>Note that you must include one of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your request. If you include more than one of these parameters, your transcription job fails.</p> <p>For a list of supported languages and their associated language codes, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a> table.</p> <note> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file must be encoded at a sample rate of 16,000 Hz or higher.</p> </note>" + "documentation":"<p>The language code that represents the language spoken in the input media file.</p> <p>If you're unsure of the language spoken in your media file, consider using <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable automatic language identification.</p> <p>Note that you must include one of <code>LanguageCode</code>, <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your request. If you include more than one of these parameters, your transcription job fails.</p> <p>For a list of supported languages and their associated language codes, refer to the <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a> table.</p> <note> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>) in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), Canada (Calgary, ca-west-1) and Africa (Cape Town, af-south-1), your media file must be encoded at a sample rate of 16,000 Hz or higher.</p> </note>" }, "MediaSampleRateHertz":{ "shape":"MediaSampleRateHertz", @@ -3193,7 +3214,7 @@ }, "LanguageOptions":{ "shape":"LanguageOptions", - "documentation":"<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p> <p>For more information, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a>.</p> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file must be encoded at a sample rate of 16,000 Hz or higher.</p>" + "documentation":"<p>You can specify two or more language codes that represent the languages you think may be present in your media. Including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</p> <p>If you include <code>LanguageOptions</code> in your request, you must also include <code>IdentifyLanguage</code>.</p> <p>For more information, refer to <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html\">Supported languages</a>.</p> <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>)in Amazon Web Services GovCloud (US) (US-West, us-gov-west-1), Amazon Web Services GovCloud (US) (US-East, us-gov-east-1), in Canada (Calgary) ca-west-1 and Africa (Cape Town) af-south-1, your media file must be encoded at a sample rate of 16,000 Hz or higher.</p>" }, "Subtitles":{ "shape":"Subtitles", diff --git a/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/service-2.json b/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/service-2.json index 7f7778b79a0..b367d9a85f5 100644 --- a/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/transfer/2018-11-05/service-2.json @@ -49,7 +49,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ResourceExistsException"} ], - "documentation":"<p>Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.</p> <p>The partner is identified with the <code>PartnerProfileId</code>, and the AS2 process is identified with the <code>LocalProfileId</code>.</p>" + "documentation":"<p>Creates an agreement. An agreement is a bilateral trading partner agreement, or partnership, between an Transfer Family server and an AS2 process. The agreement defines the file and message transfer relationship between the server and the AS2 process. To define an agreement, Transfer Family combines a server, local profile, partner profile, certificate, and other attributes.</p> <p>The partner is identified with the <code>PartnerProfileId</code>, and the AS2 process is identified with the <code>LocalProfileId</code>.</p> <note> <p>Specify <i>either</i> <code>BaseDirectory</code> or <code>CustomDirectories</code>, but not both. Specifying both causes the command to fail.</p> </note>" }, "CreateConnector":{ "name":"CreateConnector", @@ -1028,7 +1028,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ResourceExistsException"} ], - "documentation":"<p>Updates some of the parameters for an existing agreement. Provide the <code>AgreementId</code> and the <code>ServerId</code> for the agreement that you want to update, along with the new values for the parameters to update.</p>" + "documentation":"<p>Updates some of the parameters for an existing agreement. Provide the <code>AgreementId</code> and the <code>ServerId</code> for the agreement that you want to update, along with the new values for the parameters to update.</p> <note> <p>Specify <i>either</i> <code>BaseDirectory</code> or <code>CustomDirectories</code>, but not both. Specifying both causes the command to fail.</p> <p>If you update an agreement from using base directory to custom directories, the base directory is no longer used. Similarly, if you change from custom directories to a base directory, the custom directories are no longer used.</p> </note>" }, "UpdateCertificate":{ "name":"UpdateCertificate", @@ -1482,7 +1482,6 @@ "ServerId", "LocalProfileId", "PartnerProfileId", - "BaseDirectory", "AccessRole" ], "members":{ @@ -1525,6 +1524,10 @@ "EnforceMessageSigning":{ "shape":"EnforceMessageSigningType", "documentation":"<p> Determines whether or not unsigned messages from your trading partners will be accepted. </p> <ul> <li> <p> <code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p> </li> <li> <p> <code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p> </li> </ul>" + }, + "CustomDirectories":{ + "shape":"CustomDirectoriesType", + "documentation":"<p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p> <ul> <li> <p>Failed files</p> </li> <li> <p>MDN files</p> </li> <li> <p>Payload files</p> </li> <li> <p>Status files</p> </li> <li> <p>Temporary files</p> </li> </ul>" } } }, @@ -1834,6 +1837,39 @@ } } }, + "CustomDirectoriesType":{ + "type":"structure", + "required":[ + "FailedFilesDirectory", + "MdnFilesDirectory", + "PayloadFilesDirectory", + "StatusFilesDirectory", + "TemporaryFilesDirectory" + ], + "members":{ + "FailedFilesDirectory":{ + "shape":"HomeDirectory", + "documentation":"<p>Specifies a location to store failed AS2 message files.</p>" + }, + "MdnFilesDirectory":{ + "shape":"HomeDirectory", + "documentation":"<p>Specifies a location to store MDN files.</p>" + }, + "PayloadFilesDirectory":{ + "shape":"HomeDirectory", + "documentation":"<p>Specifies a location to store the payload for AS2 message files.</p>" + }, + "StatusFilesDirectory":{ + "shape":"HomeDirectory", + "documentation":"<p>Specifies a location to store AS2 status messages.</p>" + }, + "TemporaryFilesDirectory":{ + "shape":"HomeDirectory", + "documentation":"<p>Specifies a location to store temporary AS2 message files.</p>" + } + }, + "documentation":"<p>Contains Amazon S3 locations for storing specific types of AS2 message files.</p>" + }, "CustomStepDetails":{ "type":"structure", "members":{ @@ -2478,6 +2514,10 @@ "EnforceMessageSigning":{ "shape":"EnforceMessageSigningType", "documentation":"<p> Determines whether or not unsigned messages from your trading partners will be accepted. </p> <ul> <li> <p> <code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p> </li> <li> <p> <code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p> </li> </ul>" + }, + "CustomDirectories":{ + "shape":"CustomDirectoriesType", + "documentation":"<p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p> <ul> <li> <p>Failed files</p> </li> <li> <p>MDN files</p> </li> <li> <p>Payload files</p> </li> <li> <p>Status files</p> </li> <li> <p>Temporary files</p> </li> </ul>" } }, "documentation":"<p>Describes the properties of an agreement.</p>" @@ -5406,6 +5446,10 @@ "EnforceMessageSigning":{ "shape":"EnforceMessageSigningType", "documentation":"<p> Determines whether or not unsigned messages from your trading partners will be accepted. </p> <ul> <li> <p> <code>ENABLED</code>: Transfer Family rejects unsigned messages from your trading partner.</p> </li> <li> <p> <code>DISABLED</code> (default value): Transfer Family accepts unsigned messages from your trading partner.</p> </li> </ul>" + }, + "CustomDirectories":{ + "shape":"CustomDirectoriesType", + "documentation":"<p>A <code>CustomDirectoriesType</code> structure. This structure specifies custom directories for storing various AS2 message files. You can specify directories for the following types of files.</p> <ul> <li> <p>Failed files</p> </li> <li> <p>MDN files</p> </li> <li> <p>Payload files</p> </li> <li> <p>Status files</p> </li> <li> <p>Temporary files</p> </li> </ul>" } } }, diff --git a/contrib/python/botocore/py3/botocore/data/verifiedpermissions/2021-12-01/service-2.json b/contrib/python/botocore/py3/botocore/data/verifiedpermissions/2021-12-01/service-2.json index 9c57215e874..d285e68769d 100644 --- a/contrib/python/botocore/py3/botocore/data/verifiedpermissions/2021-12-01/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/verifiedpermissions/2021-12-01/service-2.json @@ -927,6 +927,10 @@ "box":true, "sensitive":true }, + "CedarJson":{ + "type":"string", + "sensitive":true + }, "Claim":{ "type":"string", "min":1, @@ -1116,9 +1120,13 @@ "contextMap":{ "shape":"ContextMap", "documentation":"<p>An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.</p> <p>Example: <code>\"contextMap\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}</code> </p>" + }, + "cedarJson":{ + "shape":"CedarJson", + "documentation":"<p>A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.</p> <p>Example: <code>{\"cedarJson\":\"{\\\"<KeyName1>\\\": true, \\\"<KeyName2>\\\": 1234}\" }</code> </p>" } }, - "documentation":"<p>Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the <code>when</code> and <code>unless</code> clauses in a policy.</p> <p>This data type is used as a request parameter for the <a href=\"https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html\">IsAuthorized</a>, <a href=\"https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html\">BatchIsAuthorized</a>, and <a href=\"https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html\">IsAuthorizedWithToken</a> operations.</p> <p>Example: <code>\"context\":{\"contextMap\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}}</code> </p>", + "documentation":"<p>Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the <code>when</code> and <code>unless</code> clauses in a policy.</p> <p>This data type is used as a request parameter for the <a href=\"https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html\">IsAuthorized</a>, <a href=\"https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_BatchIsAuthorized.html\">BatchIsAuthorized</a>, and <a href=\"https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html\">IsAuthorizedWithToken</a> operations.</p> <p>If you're passing context as part of the request, exactly one instance of <code>context</code> must be passed. If you don't want to pass context, omit the <code>context</code> parameter from your request rather than sending <code>context {}</code>.</p> <p>Example: <code>\"context\":{\"contextMap\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}}</code> </p>", "union":true }, "ContextMap":{ @@ -1470,7 +1478,11 @@ "members":{ "entityList":{ "shape":"EntityList", - "documentation":"<p>An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.</p>" + "documentation":"<p>An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.</p> <note> <p>If you include multiple entities with the same <code>identifier</code>, only the last one is processed in the request.</p> </note>" + }, + "cedarJson":{ + "shape":"CedarJson", + "documentation":"<p>A Cedar JSON string representation of the entities needed to successfully evaluate an authorization request.</p> <p>Example: <code>{\"cedarJson\": \"[{\\\"uid\\\":{\\\"type\\\":\\\"Photo\\\",\\\"id\\\":\\\"VacationPhoto94.jpg\\\"},\\\"attrs\\\":{\\\"accessLevel\\\":\\\"public\\\"},\\\"parents\\\":[]}]\"}</code> </p>" } }, "documentation":"<p>Contains the list of entities to be considered during an authorization request. This includes all principals, resources, and actions required to successfully evaluate the request.</p> <p>This data type is used as a field in the response parameter for the <a href=\"https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html\">IsAuthorized</a> and <a href=\"https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html\">IsAuthorizedWithToken</a> operations.</p>", diff --git a/contrib/python/botocore/py3/botocore/data/wafv2/2019-07-29/service-2.json b/contrib/python/botocore/py3/botocore/data/wafv2/2019-07-29/service-2.json index a46861c83e3..8e3fb21f393 100644 --- a/contrib/python/botocore/py3/botocore/data/wafv2/2019-07-29/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/wafv2/2019-07-29/service-2.json @@ -30,7 +30,7 @@ {"shape":"WAFUnavailableEntityException"}, {"shape":"WAFInvalidOperationException"} ], - "documentation":"<p>Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call <code>UpdateDistribution</code>, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </p> <p> <b>Required permissions for customer-managed IAM policies</b> </p> <p>This call requires permissions that are specific to the protected resource type. For details, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-AssociateWebACL\">Permissions for AssociateWebACL</a> in the <i>WAF Developer Guide</i>. </p> <p> <b>Temporary inconsistencies during updates</b> </p> <p>When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. </p> <p>The following are examples of the temporary inconsistencies that you might notice during change propagation: </p> <ul> <li> <p>After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. </p> </li> <li> <p>After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.</p> </li> <li> <p>After you change a rule action setting, you might see the old action in some places and the new action in others. </p> </li> <li> <p>After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.</p> </li> </ul>" + "documentation":"<p>Associates a web ACL with a resource, to protect the resource. </p> <p>Use this for all resource types except for Amazon CloudFront distributions. For Amazon CloudFront, call <code>UpdateDistribution</code> for the distribution and provide the Amazon Resource Name (ARN) of the web ACL in the web ACL ID. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </p> <p> <b>Required permissions for customer-managed IAM policies</b> </p> <p>This call requires permissions that are specific to the protected resource type. For details, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-AssociateWebACL\">Permissions for AssociateWebACL</a> in the <i>WAF Developer Guide</i>. </p> <p> <b>Temporary inconsistencies during updates</b> </p> <p>When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. </p> <p>The following are examples of the temporary inconsistencies that you might notice during change propagation: </p> <ul> <li> <p>After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. </p> </li> <li> <p>After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.</p> </li> <li> <p>After you change a rule action setting, you might see the old action in some places and the new action in others. </p> </li> <li> <p>After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.</p> </li> </ul>" }, "CheckCapacity":{ "name":"CheckCapacity", @@ -156,7 +156,7 @@ {"shape":"WAFConfigurationWarningException"}, {"shape":"WAFExpiredManagedRuleGroupVersionException"} ], - "documentation":"<p>Creates a <a>WebACL</a> per the specifications provided.</p> <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p>" + "documentation":"<p>Creates a <a>WebACL</a> per the specifications provided.</p> <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, and Amazon Web Services Verified Access instance. </p>" }, "DeleteAPIKey":{ "name":"DeleteAPIKey", @@ -302,7 +302,7 @@ {"shape":"WAFTagOperationInternalErrorException"}, {"shape":"WAFInvalidOperationException"} ], - "documentation":"<p>Deletes the specified <a>WebACL</a>. </p> <p>You can only use this if <code>ManagedByFirewallManager</code> is false in the web ACL. </p> <note> <p>Before deleting any web ACL, first disassociate it from all resources.</p> <ul> <li> <p>To retrieve a list of the resources that are associated with a web ACL, use the following calls:</p> <ul> <li> <p>For regional resources, call <a>ListResourcesForWebACL</a>.</p> </li> <li> <p>For Amazon CloudFront distributions, use the CloudFront call <code>ListDistributionsByWebACLId</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html\">ListDistributionsByWebACLId</a> in the <i>Amazon CloudFront API Reference</i>. </p> </li> </ul> </li> <li> <p>To disassociate a resource from a web ACL, use the following calls:</p> <ul> <li> <p>For regional resources, call <a>DisassociateWebACL</a>.</p> </li> <li> <p>For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call <code>UpdateDistribution</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a> in the <i>Amazon CloudFront API Reference</i>. </p> </li> </ul> </li> </ul> </note>" + "documentation":"<p>Deletes the specified <a>WebACL</a>. </p> <p>You can only use this if <code>ManagedByFirewallManager</code> is false in the web ACL. </p> <note> <p>Before deleting any web ACL, first disassociate it from all resources.</p> <ul> <li> <p>To retrieve a list of the resources that are associated with a web ACL, use the following calls:</p> <ul> <li> <p>For Amazon CloudFront distributions, use the CloudFront call <code>ListDistributionsByWebACLId</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html\">ListDistributionsByWebACLId</a> in the <i>Amazon CloudFront API Reference</i>. </p> </li> <li> <p>For all other resources, call <a>ListResourcesForWebACL</a>.</p> </li> </ul> </li> <li> <p>To disassociate a resource from a web ACL, use the following calls:</p> <ul> <li> <p>For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call <code>UpdateDistribution</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a> in the <i>Amazon CloudFront API Reference</i>. </p> </li> <li> <p>For all other resources, call <a>DisassociateWebACL</a>.</p> </li> </ul> </li> </ul> </note>" }, "DescribeAllManagedProducts":{ "name":"DescribeAllManagedProducts", @@ -366,7 +366,7 @@ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInvalidOperationException"} ], - "documentation":"<p>Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call <code>UpdateDistribution</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a> in the <i>Amazon CloudFront API Reference</i>. </p> <p> <b>Required permissions for customer-managed IAM policies</b> </p> <p>This call requires permissions that are specific to the protected resource type. For details, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-DisassociateWebACL\">Permissions for DisassociateWebACL</a> in the <i>WAF Developer Guide</i>.</p>" + "documentation":"<p>Disassociates the specified resource from its web ACL association, if it has one. </p> <p>Use this for all resource types except for Amazon CloudFront distributions. For Amazon CloudFront, call <code>UpdateDistribution</code> for the distribution and provide an empty web ACL ID. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a> in the <i>Amazon CloudFront API Reference</i>. </p> <p> <b>Required permissions for customer-managed IAM policies</b> </p> <p>This call requires permissions that are specific to the protected resource type. For details, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-DisassociateWebACL\">Permissions for DisassociateWebACL</a> in the <i>WAF Developer Guide</i>.</p>" }, "GenerateMobileSdkReleaseUrl":{ "name":"GenerateMobileSdkReleaseUrl", @@ -713,7 +713,7 @@ {"shape":"WAFInvalidParameterException"}, {"shape":"WAFInvalidOperationException"} ], - "documentation":"<p>Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. </p> <p>For Amazon CloudFront, don't use this call. Instead, use the CloudFront call <code>ListDistributionsByWebACLId</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html\">ListDistributionsByWebACLId</a> in the <i>Amazon CloudFront API Reference</i>. </p> <p> <b>Required permissions for customer-managed IAM policies</b> </p> <p>This call requires permissions that are specific to the protected resource type. For details, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-ListResourcesForWebACL\">Permissions for ListResourcesForWebACL</a> in the <i>WAF Developer Guide</i>.</p>" + "documentation":"<p>Retrieves an array of the Amazon Resource Names (ARNs) for the resources that are associated with the specified web ACL. </p> <p>For Amazon CloudFront, don't use this call. Instead, use the CloudFront call <code>ListDistributionsByWebACLId</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html\">ListDistributionsByWebACLId</a> in the <i>Amazon CloudFront API Reference</i>. </p> <p> <b>Required permissions for customer-managed IAM policies</b> </p> <p>This call requires permissions that are specific to the protected resource type. For details, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/security_iam_service-with-iam.html#security_iam_action-ListResourcesForWebACL\">Permissions for ListResourcesForWebACL</a> in the <i>WAF Developer Guide</i>.</p>" }, "ListRuleGroups":{ "name":"ListRuleGroups", @@ -781,7 +781,7 @@ {"shape":"WAFLimitsExceededException"}, {"shape":"WAFLogDestinationPermissionIssueException"} ], - "documentation":"<p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a web ACL, according to the configuration provided. </p> <note> <p>This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call. </p> <p>To modify an existing logging configuration, do the following: </p> <ol> <li> <p>Retrieve it by calling <a>GetLoggingConfiguration</a> </p> </li> <li> <p>Update its settings as needed</p> </li> <li> <p>Provide the complete logging configuration specification to this call</p> </li> </ol> </note> <note> <p>You can define one logging destination per web ACL.</p> </note> <p>You can access information about the traffic that WAF inspects using the following steps:</p> <ol> <li> <p>Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. </p> <p>The name that you give the destination must start with <code>aws-waf-logs-</code>. Depending on the type of destination, you might need to configure additional settings or permissions. </p> <p>For configuration requirements and pricing information for each destination type, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic</a> in the <i>WAF Developer Guide</i>.</p> </li> <li> <p>Associate your logging destination to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.</p> <p>For additional information about web ACL logging, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>.</p>" + "documentation":"<p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a web ACL, according to the configuration provided. </p> <p>If you configure data protection for the web ACL, the protection applies to the data that WAF sends to the logs. </p> <note> <p>This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call. </p> <p>To modify an existing logging configuration, do the following: </p> <ol> <li> <p>Retrieve it by calling <a>GetLoggingConfiguration</a> </p> </li> <li> <p>Update its settings as needed</p> </li> <li> <p>Provide the complete logging configuration specification to this call</p> </li> </ol> </note> <note> <p>You can define one logging destination per web ACL.</p> </note> <p>You can access information about the traffic that WAF inspects using the following steps:</p> <ol> <li> <p>Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. </p> <p>The name that you give the destination must start with <code>aws-waf-logs-</code>. Depending on the type of destination, you might need to configure additional settings or permissions. </p> <p>For configuration requirements and pricing information for each destination type, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic</a> in the <i>WAF Developer Guide</i>.</p> </li> <li> <p>Associate your logging destination to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.</p> <p>For additional information about web ACL logging, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>.</p>" }, "PutManagedRuleSetVersions":{ "name":"PutManagedRuleSetVersions", @@ -952,7 +952,7 @@ {"shape":"WAFExpiredManagedRuleGroupVersionException"}, {"shape":"WAFConfigurationWarningException"} ], - "documentation":"<p>Updates the specified <a>WebACL</a>. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL. </p> <note> <p>This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. </p> <p>To modify a web ACL, do the following: </p> <ol> <li> <p>Retrieve it by calling <a>GetWebACL</a> </p> </li> <li> <p>Update its settings as needed</p> </li> <li> <p>Provide the complete web ACL specification to this call</p> </li> </ol> </note> <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p> <b>Temporary inconsistencies during updates</b> </p> <p>When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. </p> <p>The following are examples of the temporary inconsistencies that you might notice during change propagation: </p> <ul> <li> <p>After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. </p> </li> <li> <p>After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.</p> </li> <li> <p>After you change a rule action setting, you might see the old action in some places and the new action in others. </p> </li> <li> <p>After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.</p> </li> </ul>" + "documentation":"<p>Updates the specified <a>WebACL</a>. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL. </p> <note> <p>This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. </p> <p>To modify a web ACL, do the following: </p> <ol> <li> <p>Retrieve it by calling <a>GetWebACL</a> </p> </li> <li> <p>Update its settings as needed</p> </li> <li> <p>Provide the complete web ACL specification to this call</p> </li> </ol> </note> <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, and Amazon Web Services Verified Access instance. </p> <p> <b>Temporary inconsistencies during updates</b> </p> <p>When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. </p> <p>The following are examples of the temporary inconsistencies that you might notice during change propagation: </p> <ul> <li> <p>After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. </p> </li> <li> <p>After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.</p> </li> <li> <p>After you change a rule action setting, you might see the old action in some places and the new action in others. </p> </li> <li> <p>After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.</p> </li> </ul>" } }, "shapes":{ @@ -1325,7 +1325,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Rules":{ "shape":"Rules", @@ -1703,7 +1703,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "TokenDomains":{ "shape":"APIKeyTokenDomains", @@ -1735,7 +1735,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Description":{ "shape":"EntityDescription", @@ -1778,7 +1778,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Description":{ "shape":"EntityDescription", @@ -1818,7 +1818,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Capacity":{ "shape":"CapacityUnit", @@ -1870,7 +1870,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "DefaultAction":{ "shape":"DefaultAction", @@ -1888,6 +1888,10 @@ "shape":"VisibilityConfig", "documentation":"<p>Defines and enables Amazon CloudWatch metrics and web request sample collection. </p>" }, + "DataProtectionConfig":{ + "shape":"DataProtectionConfig", + "documentation":"<p>Specifies data protection to apply to the web request data that WAF stores for the web ACL. This is a web ACL level data protection option. </p> <p>The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including WAF logging, web ACL request sampling, Amazon Web Services Managed Rules, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging. </p>" + }, "Tags":{ "shape":"TagList", "documentation":"<p>An array of key:value pairs to associate with the resource.</p>" @@ -2018,6 +2022,56 @@ }, "documentation":"<p>The response body to use in a custom response to a web request. This is referenced by key from <a>CustomResponse</a> <code>CustomResponseBodyKey</code>.</p>" }, + "DataProtection":{ + "type":"structure", + "required":[ + "Field", + "Action" + ], + "members":{ + "Field":{ + "shape":"FieldToProtect", + "documentation":"<p>Specifies the field type and optional keys to apply the protection behavior to. </p>" + }, + "Action":{ + "shape":"DataProtectionAction", + "documentation":"<p>Specifies how to protect the field. WAF can apply a one-way hash to the field or hard code a string substitution. </p> <ul> <li> <p>One-way hash example: <code>ade099751dEXAMPLEHASH2ea9f3393f80dd5d3bEXAMPLEHASH966ae0d3cd5a1e</code> </p> </li> <li> <p>Substitution example: <code>REDACTED</code> </p> </li> </ul>" + }, + "ExcludeRuleMatchDetails":{ + "shape":"Boolean", + "documentation":"<p>Specifies whether to also protect any rule match details from the web ACL logs when applying data protection this field type and keys. WAF logs these details for non-terminating matching rules and for the terminating matching rule. For additional information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html\">Log fields for web ACL traffic</a> in the <i>WAF Developer Guide</i>.</p> <p>Default: <code>FALSE</code> </p>" + }, + "ExcludeRateBasedDetails":{ + "shape":"Boolean", + "documentation":"<p>Specifies whether to also protect any rate-based rule details from the web ACL logs when applying data protection for this field type and keys. For additional information, see the log field <code>rateBasedRuleList</code> at <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html\">Log fields for web ACL traffic</a> in the <i>WAF Developer Guide</i>.</p> <p>Default: <code>FALSE</code> </p>" + } + }, + "documentation":"<p>Specifies the protection behavior for a field type. This is part of the data protection configuration for a web ACL. </p>" + }, + "DataProtectionAction":{ + "type":"string", + "enum":[ + "SUBSTITUTION", + "HASH" + ] + }, + "DataProtectionConfig":{ + "type":"structure", + "required":["DataProtections"], + "members":{ + "DataProtections":{ + "shape":"DataProtections", + "documentation":"<p>An array of data protection configurations for specific web request field types. This is defined for each web ACL. WAF applies the specified protection to all web requests that the web ACL inspects. </p>" + } + }, + "documentation":"<p>Specifies data protection to apply to the web request data that WAF stores for the web ACL. This is a web ACL level data protection option. </p> <p>The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including WAF logging, web ACL request sampling, Amazon Web Services Managed Rules, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging. </p> <p>This is part of the data protection configuration for a web ACL. </p>" + }, + "DataProtections":{ + "type":"list", + "member":{"shape":"DataProtection"}, + "max":26, + "min":1 + }, "DefaultAction":{ "type":"structure", "members":{ @@ -2041,7 +2095,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "APIKey":{ "shape":"APIKey", @@ -2095,7 +2149,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -2165,7 +2219,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -2197,7 +2251,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -2229,7 +2283,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -2252,7 +2306,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" } } }, @@ -2278,7 +2332,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" } } }, @@ -2309,7 +2363,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "VersionName":{ "shape":"VersionKeyString", @@ -2500,7 +2554,7 @@ "documentation":"<p>Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.</p> <note> <p>You can use this choice only with a string match <code>ByteMatchStatement</code> with the <code>PositionalConstraint</code> set to <code>EXACTLY</code>. </p> </note> <p>You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html\">Log fields</a> in the <i>WAF Developer Guide</i>. </p> <p>Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.</p>" } }, - "documentation":"<p>Specifies a web request component to be used in a rule match statement or in a logging configuration. </p> <ul> <li> <p>In a rule statement, this is the part of the web request that you want WAF to inspect. Include the single <code>FieldToMatch</code> type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in <code>FieldToMatch</code> for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component.</p> <p>Example JSON for a <code>QueryString</code> field to match: </p> <p> <code> \"FieldToMatch\": { \"QueryString\": {} }</code> </p> <p>Example JSON for a <code>Method</code> field to match specification:</p> <p> <code> \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }</code> </p> </li> <li> <p>In a logging configuration, this is used in the <code>RedactedFields</code> property to specify a field to redact from the logging records. For this use case, note the following: </p> <ul> <li> <p>Even though all <code>FieldToMatch</code> settings are available, the only valid settings for field redaction are <code>UriPath</code>, <code>QueryString</code>, <code>SingleHeader</code>, and <code>Method</code>.</p> </li> <li> <p>In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, but for field redaction, you are specifying the component type to redact from the logs. </p> </li> <li> <p>If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration. </p> </li> </ul> </li> </ul>" + "documentation":"<p>Specifies a web request component to be used in a rule match statement or in a logging configuration. </p> <ul> <li> <p>In a rule statement, this is the part of the web request that you want WAF to inspect. Include the single <code>FieldToMatch</code> type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in <code>FieldToMatch</code> for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component.</p> <p>Example JSON for a <code>QueryString</code> field to match: </p> <p> <code> \"FieldToMatch\": { \"QueryString\": {} }</code> </p> <p>Example JSON for a <code>Method</code> field to match specification:</p> <p> <code> \"FieldToMatch\": { \"Method\": { \"Name\": \"DELETE\" } }</code> </p> </li> <li> <p>In a logging configuration, this is used in the <code>RedactedFields</code> property to specify a field to redact from the logging records. For this use case, note the following: </p> <ul> <li> <p>Even though all <code>FieldToMatch</code> settings are available, the only valid settings for field redaction are <code>UriPath</code>, <code>QueryString</code>, <code>SingleHeader</code>, and <code>Method</code>.</p> </li> <li> <p>In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, but for field redaction, you are specifying the component type to redact from the logs. </p> </li> <li> <p>If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.</p> </li> </ul> </li> </ul>" }, "FieldToMatchData":{ "type":"string", @@ -2508,6 +2562,42 @@ "min":1, "pattern":".*\\S.*" }, + "FieldToProtect":{ + "type":"structure", + "required":["FieldType"], + "members":{ + "FieldType":{ + "shape":"FieldToProtectType", + "documentation":"<p>Specifies the web request component type to protect. </p>" + }, + "FieldKeys":{ + "shape":"FieldToProtectKeys", + "documentation":"<p>Specifies the keys to protect for the specified field type. If you don't specify any key, then all keys for the field type are protected. </p>" + } + }, + "documentation":"<p>Specifies a field type and keys to protect in stored web request data. This is part of the data protection configuration for a web ACL. </p>" + }, + "FieldToProtectKeyName":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*\\S.*" + }, + "FieldToProtectKeys":{ + "type":"list", + "member":{"shape":"FieldToProtectKeyName"}, + "max":100 + }, + "FieldToProtectType":{ + "type":"string", + "enum":[ + "SINGLE_HEADER", + "SINGLE_COOKIE", + "SINGLE_QUERY_ARGUMENT", + "QUERY_STRING", + "BODY" + ] + }, "Filter":{ "type":"structure", "required":[ @@ -2682,7 +2772,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "APIKey":{ "shape":"APIKey", @@ -2717,7 +2807,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -2779,7 +2869,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -2856,7 +2946,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "WebACLName":{ "shape":"EntityName", @@ -2903,7 +2993,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -2933,7 +3023,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -2978,7 +3068,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "TimeWindow":{ "shape":"TimeWindow", @@ -3040,7 +3130,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -3475,7 +3565,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "NextMarker":{ "shape":"NextMarker", @@ -3522,7 +3612,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "NextMarker":{ "shape":"NextMarker", @@ -3557,7 +3647,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "NextMarker":{ "shape":"NextMarker", @@ -3588,7 +3678,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "NextMarker":{ "shape":"NextMarker", @@ -3619,7 +3709,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "NextMarker":{ "shape":"NextMarker", @@ -3654,7 +3744,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "NextMarker":{ "shape":"NextMarker", @@ -3721,7 +3811,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "NextMarker":{ "shape":"NextMarker", @@ -3756,7 +3846,7 @@ }, "ResourceType":{ "shape":"ResourceType", - "documentation":"<p>Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <note> <p>If you don't provide a resource type, the call uses the resource type <code>APPLICATION_LOAD_BALANCER</code>. </p> </note> <p>Default: <code>APPLICATION_LOAD_BALANCER</code> </p>" + "documentation":"<p>Retrieves the web ACLs that are used by the specified resource type. </p> <p>For Amazon CloudFront, don't use this call. Instead, use the CloudFront call <code>ListDistributionsByWebACLId</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html\">ListDistributionsByWebACLId</a> in the <i>Amazon CloudFront API Reference</i>. </p> <note> <p>If you don't provide a resource type, the call uses the resource type <code>APPLICATION_LOAD_BALANCER</code>. </p> </note> <p>Default: <code>APPLICATION_LOAD_BALANCER</code> </p>" } } }, @@ -3775,7 +3865,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "NextMarker":{ "shape":"NextMarker", @@ -3837,7 +3927,7 @@ "members":{ "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "NextMarker":{ "shape":"NextMarker", @@ -3902,7 +3992,7 @@ }, "RedactedFields":{ "shape":"RedactedFields", - "documentation":"<p>The parts of the request that you want to keep out of the logs.</p> <p>For example, if you redact the <code>SingleHeader</code> field, the <code>HEADER</code> field in the logs will be <code>REDACTED</code> for all rules that use the <code>SingleHeader</code> <code>FieldToMatch</code> setting. </p> <p>Redaction applies only to the component that's specified in the rule's <code>FieldToMatch</code> setting, so the <code>SingleHeader</code> redaction doesn't apply to rules that use the <code>Headers</code> <code>FieldToMatch</code>.</p> <note> <p>You can specify only the following fields for redaction: <code>UriPath</code>, <code>QueryString</code>, <code>SingleHeader</code>, and <code>Method</code>.</p> </note> <note> <p>This setting has no impact on request sampling. With request sampling, the only way to exclude fields is by disabling sampling in the web ACL visibility configuration. </p> </note>" + "documentation":"<p>The parts of the request that you want to keep out of the logs.</p> <p>For example, if you redact the <code>SingleHeader</code> field, the <code>HEADER</code> field in the logs will be <code>REDACTED</code> for all rules that use the <code>SingleHeader</code> <code>FieldToMatch</code> setting. </p> <p>If you configure data protection for the web ACL, the protection applies to the data that WAF sends to the logs. </p> <p>Redaction applies only to the component that's specified in the rule's <code>FieldToMatch</code> setting, so the <code>SingleHeader</code> redaction doesn't apply to rules that use the <code>Headers</code> <code>FieldToMatch</code>.</p> <note> <p>You can specify only the following fields for redaction: <code>UriPath</code>, <code>QueryString</code>, <code>SingleHeader</code>, and <code>Method</code>.</p> </note> <note> <p>This setting has no impact on request sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.</p> </note>" }, "ManagedByFirewallManager":{ "shape":"Boolean", @@ -3921,7 +4011,7 @@ "documentation":"<p>The owner of the logging configuration, which must be set to <code>CUSTOMER</code> for the configurations that you manage. </p> <p>The log scope <code>SECURITY_LAKE</code> indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see <a href=\"https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html\">Collecting data from Amazon Web Services services</a> in the <i>Amazon Security Lake user guide</i>. </p> <p>Default: <code>CUSTOMER</code> </p>" } }, - "documentation":"<p>Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records. </p> <note> <p>You can define one logging destination per web ACL.</p> </note> <p>You can access information about the traffic that WAF inspects using the following steps:</p> <ol> <li> <p>Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. </p> <p>The name that you give the destination must start with <code>aws-waf-logs-</code>. Depending on the type of destination, you might need to configure additional settings or permissions. </p> <p>For configuration requirements and pricing information for each destination type, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic</a> in the <i>WAF Developer Guide</i>.</p> </li> <li> <p>Associate your logging destination to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.</p> <p>For additional information about web ACL logging, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>.</p>" + "documentation":"<p>Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records. </p> <p>If you configure data protection for the web ACL, the protection applies to the data that WAF sends to the logs. </p> <note> <p>You can define one logging destination per web ACL.</p> </note> <p>You can access information about the traffic that WAF inspects using the following steps:</p> <ol> <li> <p>Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. </p> <p>The name that you give the destination must start with <code>aws-waf-logs-</code>. Depending on the type of destination, you might need to configure additional settings or permissions. </p> <p>For configuration requirements and pricing information for each destination type, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic</a> in the <i>WAF Developer Guide</i>.</p> </li> <li> <p>Associate your logging destination to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.</p> <p>For additional information about web ACL logging, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>.</p>" }, "LoggingConfigurations":{ "type":"list", @@ -4076,7 +4166,7 @@ }, "RuleActionOverrides":{ "shape":"RuleActionOverrides", - "documentation":"<p>Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change. </p> <p>You can use overrides for testing, for example you can override all of rule actions to <code>Count</code> and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.</p>" + "documentation":"<p>Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change. </p> <note> <p>Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, WAF doesn't return an error and doesn't apply the override setting.</p> </note> <p>You can use overrides for testing, for example you can override all of rule actions to <code>Count</code> and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.</p>" } }, "documentation":"<p>A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling <a>ListAvailableManagedRuleGroups</a>.</p> <p>You cannot nest a <code>ManagedRuleGroupStatement</code>, for example for use inside a <code>NotStatement</code> or <code>OrStatement</code>. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.</p> <note> <p>You are charged additional fees when you use the WAF Bot Control managed rule group <code>AWSManagedRulesBotControlRuleSet</code>, the WAF Fraud Control account takeover prevention (ATP) managed rule group <code>AWSManagedRulesATPRuleSet</code>, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group <code>AWSManagedRulesACFPRuleSet</code>. For more information, see <a href=\"http://aws.amazon.com/waf/pricing/\">WAF Pricing</a>.</p> </note>" @@ -4404,7 +4494,8 @@ "ASSOCIATED_RESOURCE_TYPE", "SCOPE_DOWN", "CUSTOM_KEYS", - "ACP_RULE_SET_RESPONSE_INSPECTION" + "ACP_RULE_SET_RESPONSE_INSPECTION", + "DATA_PROTECTION_CONFIG" ] }, "ParameterExceptionParameter":{ @@ -4529,7 +4620,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -4595,7 +4686,7 @@ "members":{ "Limit":{ "shape":"RateLimit", - "documentation":"<p>The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a <code>ScopeDownStatement</code>, this limit is applied only to the requests that match the statement.</p> <p>Examples: </p> <ul> <li> <p>If you aggregate on just the IP address, this is the limit on requests from any single IP address. </p> </li> <li> <p>If you aggregate on the HTTP method and the query argument name \"city\", then this is the limit on requests for any single method, city pair. </p> </li> </ul>" + "documentation":"<p>The limit on requests during the specified evaluation window for a single aggregation instance for the rate-based rule. If the rate-based statement includes a <code>ScopeDownStatement</code>, this limit is applied only to the requests that match the statement.</p> <p>Examples: </p> <ul> <li> <p>If you aggregate on just the IP address, this is the limit on requests from any single IP address. </p> </li> <li> <p>If you aggregate on the HTTP method and the query argument name \"city\", then this is the limit on requests for any single method, city pair. </p> </li> </ul>" }, "EvaluationWindowSec":{ "shape":"EvaluationWindowSec", @@ -5252,7 +5343,7 @@ }, "RuleLabels":{ "shape":"Labels", - "documentation":"<p>Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace. </p> <p>Rules that run after this rule in the web ACL can match against these labels using a <code>LabelMatchStatement</code>.</p> <p>For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:</p> <ul> <li> <p>Separate each component of the label with a colon. </p> </li> <li> <p>Each namespace or name can have up to 128 characters.</p> </li> <li> <p>You can specify up to 5 namespaces in a label.</p> </li> <li> <p>Don't use the following reserved words in your label specification: <code>aws</code>, <code>waf</code>, <code>managed</code>, <code>rulegroup</code>, <code>webacl</code>, <code>regexpatternset</code>, or <code>ipset</code>.</p> </li> </ul> <p>For example, <code>myLabelName</code> or <code>nameSpace1:nameSpace2:myLabelName</code>. </p>" + "documentation":"<p>Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace. </p> <note> <p>Any rule that isn't a rule group reference statement or managed rule group statement can add labels to matching web requests.</p> </note> <p>Rules that run after this rule in the web ACL can match against these labels using a <code>LabelMatchStatement</code>.</p> <p>For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:</p> <ul> <li> <p>Separate each component of the label with a colon. </p> </li> <li> <p>Each namespace or name can have up to 128 characters.</p> </li> <li> <p>You can specify up to 5 namespaces in a label.</p> </li> <li> <p>Don't use the following reserved words in your label specification: <code>aws</code>, <code>waf</code>, <code>managed</code>, <code>rulegroup</code>, <code>webacl</code>, <code>regexpatternset</code>, or <code>ipset</code>.</p> </li> </ul> <p>For example, <code>myLabelName</code> or <code>nameSpace1:nameSpace2:myLabelName</code>. </p>" }, "VisibilityConfig":{ "shape":"VisibilityConfig", @@ -5304,14 +5395,14 @@ "members":{ "Name":{ "shape":"EntityName", - "documentation":"<p>The name of the rule to override.</p>" + "documentation":"<p>The name of the rule to override.</p> <note> <p>Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, WAF doesn't return an error and doesn't apply the override setting.</p> </note>" }, "ActionToUse":{ "shape":"RuleAction", "documentation":"<p>The override action to use, in place of the configured action of the rule in the rule group. </p>" } }, - "documentation":"<p>Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change. </p> <p>You can use overrides for testing, for example you can override all of rule actions to <code>Count</code> and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.</p>" + "documentation":"<p>Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change. </p> <note> <p>Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, WAF doesn't return an error and doesn't apply the override setting.</p> </note> <p>You can use overrides for testing, for example you can override all of rule actions to <code>Count</code> and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.</p>" }, "RuleActionOverrides":{ "type":"list", @@ -5389,7 +5480,7 @@ }, "RuleActionOverrides":{ "shape":"RuleActionOverrides", - "documentation":"<p>Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change. </p> <p>You can use overrides for testing, for example you can override all of rule actions to <code>Count</code> and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.</p>" + "documentation":"<p>Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change. </p> <note> <p>Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, WAF doesn't return an error and doesn't apply the override setting.</p> </note> <p>You can use overrides for testing, for example you can override all of rule actions to <code>Count</code> and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.</p>" } }, "documentation":"<p>A rule statement used to run the rules that are defined in a <a>RuleGroup</a>. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.</p> <p>You cannot nest a <code>RuleGroupReferenceStatement</code>, for example for use inside a <code>NotStatement</code> or <code>OrStatement</code>. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.</p>" @@ -5909,7 +6000,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -5955,7 +6046,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -6008,7 +6099,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -6053,7 +6144,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -6107,7 +6198,7 @@ }, "Scope":{ "shape":"Scope", - "documentation":"<p>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" + "documentation":"<p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. </p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>" }, "Id":{ "shape":"EntityId", @@ -6129,6 +6220,10 @@ "shape":"VisibilityConfig", "documentation":"<p>Defines and enables Amazon CloudWatch metrics and web request sample collection. </p>" }, + "DataProtectionConfig":{ + "shape":"DataProtectionConfig", + "documentation":"<p>Specifies data protection to apply to the web request data that WAF stores for the web ACL. This is a web ACL level data protection option. </p> <p>The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including WAF logging, web ACL request sampling, Amazon Web Services Managed Rules, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging. </p>" + }, "LockToken":{ "shape":"LockToken", "documentation":"<p>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like <code>update</code> and <code>delete</code>. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another <code>get</code>, and use the new token returned by that operation. </p>" @@ -6222,7 +6317,7 @@ "members":{ "SampledRequestsEnabled":{ "shape":"Boolean", - "documentation":"<p>Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console. </p> <note> <p>Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration. </p> </note>" + "documentation":"<p>Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console. </p> <p>If you configure data protection for the web ACL, the protection applies to the web ACL's sampled web request data. </p> <note> <p>Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.</p> </note>" }, "CloudWatchMetricsEnabled":{ "shape":"Boolean", @@ -6394,7 +6489,7 @@ "members":{ "Message":{"shape":"ErrorMessage"} }, - "documentation":"<p>WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.</p>", + "documentation":"<p>WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resource specifications in your request parameters and then retry the operation.</p>", "exception":true }, "WAFUnsupportedAggregateKeyTypeException":{ @@ -6443,6 +6538,10 @@ "shape":"VisibilityConfig", "documentation":"<p>Defines and enables Amazon CloudWatch metrics and web request sample collection. </p>" }, + "DataProtectionConfig":{ + "shape":"DataProtectionConfig", + "documentation":"<p>Specifies data protection to apply to the web request data that WAF stores for the web ACL. This is a web ACL level data protection option. </p> <p>The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including WAF logging, web ACL request sampling, Amazon Web Services Managed Rules, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging. </p>" + }, "Capacity":{ "shape":"ConsumedCapacity", "documentation":"<p>The web ACL capacity units (WCUs) currently being used by this web ACL. </p> <p>WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html\">WAF web ACL capacity units (WCU)</a> in the <i>WAF Developer Guide</i>. </p>" @@ -6488,7 +6587,7 @@ "documentation":"<p>Indicates whether this web ACL was created by a customer account and then retrofitted by Firewall Manager. If true, then the web ACL is currently being managed by a Firewall Manager WAF policy, and only Firewall Manager can manage any Firewall Manager rule groups in the web ACL. See also the properties <code>ManagedByFirewallManager</code>, <code>PreProcessFirewallManagerRuleGroups</code>, and <code>PostProcessFirewallManagerRuleGroups</code>. </p>" } }, - "documentation":"<p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p>" + "documentation":"<p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, and Amazon Web Services Verified Access instance. </p>" }, "WebACLSummaries":{ "type":"list", @@ -6539,5 +6638,5 @@ "documentation":"<p>A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. </p>" } }, - "documentation":"<fullname>WAF</fullname> <note> <p>This is the latest version of the <b>WAF</b> API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.</p> <p>If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. WAF Classic support will end on September 30, 2025. </p> <p>For information about WAF, including how to migrate your WAF Classic resources to this version, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">WAF Developer Guide</a>. </p> </note> <p>WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, or Amazon Web Services Verified Access instance. WAF also lets you control access to your content, to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code (Forbidden), or with a custom response. </p> <p>This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and guidance for configuring and using WAF, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html\">WAF Developer Guide</a>.</p> <p>You can make calls using the endpoints listed in <a href=\"https://docs.aws.amazon.com/general/latest/gr/waf.html\">WAF endpoints and quotas</a>. </p> <ul> <li> <p>For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> </li> <li> <p>For Amazon CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.</p> </li> </ul> <p>Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">Amazon Web Services SDKs</a>.</p>" + "documentation":"<fullname>WAF </fullname> <note> <p>This is the latest version of the <b>WAF</b> API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like \"V2\" or \"v2\", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.</p> <p>If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. WAF Classic support will end on September 30, 2025. </p> <p>For information about WAF, including how to migrate your WAF Classic resources to this version, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">WAF Developer Guide</a>. </p> </note> <p>WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to a protected resource. Protected resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync GraphQL API, Amazon Cognito user pool, App Runner service, and Amazon Web Services Verified Access instance. WAF also lets you control access to your content, to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code (Forbidden), or with a custom response. </p> <p>This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and guidance for configuring and using WAF, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html\">WAF Developer Guide</a>.</p> <p>You can make calls using the endpoints listed in <a href=\"https://docs.aws.amazon.com/general/latest/gr/waf.html\">WAF endpoints and quotas</a>. </p> <ul> <li> <p>For regional resources, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </p> </li> <li> <p>For Amazon CloudFront, you must use the API endpoint listed for US East (N. Virginia): us-east-1.</p> </li> </ul> <p>Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">Amazon Web Services SDKs</a>.</p>" } diff --git a/contrib/python/botocore/py3/botocore/data/workspaces-thin-client/2023-08-22/service-2.json b/contrib/python/botocore/py3/botocore/data/workspaces-thin-client/2023-08-22/service-2.json index 0442a76e609..b944e987eaa 100644 --- a/contrib/python/botocore/py3/botocore/data/workspaces-thin-client/2023-08-22/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/workspaces-thin-client/2023-08-22/service-2.json @@ -394,7 +394,7 @@ }, "desktopArn":{ "shape":"Arn", - "documentation":"<p>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.</p>" }, "desktopEndpoint":{ "shape":"DesktopEndpoint", @@ -671,7 +671,9 @@ }, "DeviceName":{ "type":"string", - "pattern":"[0-9\\p{IsAlphabetic}+:,.@'\" -]{1,64}", + "max":64, + "min":0, + "pattern":"$|^[0-9\\p{IsAlphabetic}+:,.@'\" -]*", "sensitive":true }, "DeviceSoftwareSetComplianceStatus":{ @@ -770,7 +772,7 @@ }, "desktopArn":{ "shape":"Arn", - "documentation":"<p>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.</p>" }, "desktopEndpoint":{ "shape":"DesktopEndpoint", @@ -853,7 +855,9 @@ }, "EnvironmentName":{ "type":"string", - "pattern":"[0-9\\p{IsAlphabetic}+:,.@'\" -][0-9\\p{IsAlphabetic}+=:,.@'\" -]{0,63}", + "max":64, + "min":0, + "pattern":"$|^[0-9\\p{IsAlphabetic}+:,.@'\" -][0-9\\p{IsAlphabetic}+=:,.@'\" -]*", "sensitive":true }, "EnvironmentSoftwareSetComplianceStatus":{ @@ -877,7 +881,7 @@ }, "desktopArn":{ "shape":"Arn", - "documentation":"<p>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.</p>" }, "desktopEndpoint":{ "shape":"DesktopEndpoint", @@ -1136,6 +1140,7 @@ }, "MaintenanceWindow":{ "type":"structure", + "required":["type"], "members":{ "type":{ "shape":"MaintenanceWindowType", @@ -1521,7 +1526,7 @@ }, "desktopArn":{ "shape":"Arn", - "documentation":"<p>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Web, or AppStream 2.0.</p>" + "documentation":"<p>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.</p>" }, "desktopEndpoint":{ "shape":"DesktopEndpoint", diff --git a/contrib/python/botocore/py3/botocore/data/workspaces-web/2020-07-08/service-2.json b/contrib/python/botocore/py3/botocore/data/workspaces-web/2020-07-08/service-2.json index 4f4b3490ada..6fbb495b931 100644 --- a/contrib/python/botocore/py3/botocore/data/workspaces-web/2020-07-08/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/workspaces-web/2020-07-08/service-2.json @@ -2201,6 +2201,10 @@ "shape":"TagList", "documentation":"<p>The tags to add to the user settings resource. A tag is a key-value pair.</p>" }, + "toolbarConfiguration":{ + "shape":"ToolbarConfiguration", + "documentation":"<p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>" + }, "uploadAllowed":{ "shape":"EnabledType", "documentation":"<p>Specifies whether the user can upload files from the local device to the streaming session.</p>" @@ -2941,6 +2945,10 @@ "max":100, "min":1 }, + "HiddenToolbarItemList":{ + "type":"list", + "member":{"shape":"ToolbarItem"} + }, "IdentityProvider":{ "type":"structure", "required":["identityProviderArn"], @@ -3634,6 +3642,19 @@ "max":5000, "min":1 }, + "MaxDisplayResolution":{ + "type":"string", + "enum":[ + "size4096X2160", + "size3840X2160", + "size3440X1440", + "size2560X1440", + "size1920X1080", + "size1280X720", + "size1024X768", + "size800X600" + ] + }, "MaxResults":{ "type":"integer", "box":true, @@ -4228,6 +4249,45 @@ }, "exception":true }, + "ToolbarConfiguration":{ + "type":"structure", + "members":{ + "hiddenToolbarItems":{ + "shape":"HiddenToolbarItemList", + "documentation":"<p>The list of toolbar items to be hidden.</p>" + }, + "maxDisplayResolution":{ + "shape":"MaxDisplayResolution", + "documentation":"<p>The maximum display resolution that is allowed for the session.</p>" + }, + "toolbarType":{ + "shape":"ToolbarType", + "documentation":"<p>The type of toolbar displayed during the session.</p>" + }, + "visualMode":{ + "shape":"VisualMode", + "documentation":"<p>The visual mode of the toolbar.</p>" + } + }, + "documentation":"<p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>" + }, + "ToolbarItem":{ + "type":"string", + "enum":[ + "Windows", + "DualMonitor", + "FullScreen", + "Webcam", + "Microphone" + ] + }, + "ToolbarType":{ + "type":"string", + "enum":[ + "Floating", + "Docked" + ] + }, "TrustStore":{ "type":"structure", "required":["trustStoreArn"], @@ -4614,6 +4674,10 @@ "shape":"EnabledType", "documentation":"<p>Specifies whether the user can print to the local device.</p>" }, + "toolbarConfiguration":{ + "shape":"ToolbarConfiguration", + "documentation":"<p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>" + }, "uploadAllowed":{ "shape":"EnabledType", "documentation":"<p>Specifies whether the user can upload files from the local device to the streaming session.</p>" @@ -4722,6 +4786,10 @@ "shape":"EnabledType", "documentation":"<p>Specifies whether the user can print to the local device.</p>" }, + "toolbarConfiguration":{ + "shape":"ToolbarConfiguration", + "documentation":"<p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>" + }, "uploadAllowed":{ "shape":"EnabledType", "documentation":"<p>Specifies whether the user can upload files from the local device to the streaming session.</p>" @@ -4773,6 +4841,10 @@ "shape":"EnabledType", "documentation":"<p>Specifies whether the user can print to the local device.</p>" }, + "toolbarConfiguration":{ + "shape":"ToolbarConfiguration", + "documentation":"<p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>" + }, "uploadAllowed":{ "shape":"EnabledType", "documentation":"<p>Specifies whether the user can upload files from the local device to the streaming session.</p>" @@ -4842,6 +4914,13 @@ "other" ] }, + "VisualMode":{ + "type":"string", + "enum":[ + "Dark", + "Light" + ] + }, "VpcId":{ "type":"string", "max":255, diff --git a/contrib/python/botocore/py3/botocore/data/workspaces/2015-04-08/service-2.json b/contrib/python/botocore/py3/botocore/data/workspaces/2015-04-08/service-2.json index ebc4fada5dc..c583e05a314 100644 --- a/contrib/python/botocore/py3/botocore/data/workspaces/2015-04-08/service-2.json +++ b/contrib/python/botocore/py3/botocore/data/workspaces/2015-04-08/service-2.json @@ -2096,6 +2096,8 @@ "POWER", "GRAPHICS", "POWERPRO", + "GENERALPURPOSE_4XLARGE", + "GENERALPURPOSE_8XLARGE", "GRAPHICSPRO", "GRAPHICS_G4DN", "GRAPHICSPRO_G4DN" diff --git a/contrib/python/botocore/py3/botocore/eventstream.py b/contrib/python/botocore/py3/botocore/eventstream.py index 1f725ff4129..583ceb03fe7 100644 --- a/contrib/python/botocore/py3/botocore/eventstream.py +++ b/contrib/python/botocore/py3/botocore/eventstream.py @@ -20,7 +20,6 @@ from botocore.exceptions import EventStreamError # byte length of the prelude (total_length + header_length + prelude_crc) _PRELUDE_LENGTH = 12 _MAX_HEADERS_LENGTH = 128 * 1024 # 128 Kb -_MAX_PAYLOAD_LENGTH = 16 * 1024**2 # 16 Mb class ParserError(Exception): @@ -46,10 +45,14 @@ class InvalidHeadersLength(ParserError): class InvalidPayloadLength(ParserError): - """Payload length is longer than the maximum.""" + """Payload length is longer than the maximum. + + DEPRECATED: This case is no longer validated client side. Payloads + of varying lengths are now supported by AWS services. + """ def __init__(self, length): - message = f'Payload length of {length} exceeded the maximum of {_MAX_PAYLOAD_LENGTH}' + message = f'Payload length of {length} exceeded the maximum of 24MB.' super().__init__(message) @@ -459,9 +462,6 @@ class EventStreamBuffer: if prelude.headers_length > _MAX_HEADERS_LENGTH: raise InvalidHeadersLength(prelude.headers_length) - if prelude.payload_length > _MAX_PAYLOAD_LENGTH: - raise InvalidPayloadLength(prelude.payload_length) - def _parse_prelude(self): prelude_bytes = self._data[:_PRELUDE_LENGTH] raw_prelude, _ = DecodeUtils.unpack_prelude(prelude_bytes) diff --git a/contrib/python/botocore/py3/botocore/exceptions.py b/contrib/python/botocore/py3/botocore/exceptions.py index 9fa0dfaa846..10a7c586d09 100644 --- a/contrib/python/botocore/py3/botocore/exceptions.py +++ b/contrib/python/botocore/py3/botocore/exceptions.py @@ -814,3 +814,21 @@ class EndpointResolutionError(EndpointProviderError): class UnknownEndpointResolutionBuiltInName(EndpointProviderError): fmt = 'Unknown builtin variable name: {name}' + + +class InvalidChecksumConfigError(BotoCoreError): + """Error when an invalid checksum config value is supplied.""" + + fmt = ( + 'Unsupported configuration value for {config_key}. ' + 'Expected one of {valid_options} but got {config_value}.' + ) + + +class UnsupportedServiceProtocolsError(BotoCoreError): + """Error when a service does not use any protocol supported by botocore.""" + + fmt = ( + 'Botocore supports {botocore_supported_protocols}, but service {service} only ' + 'supports {service_supported_protocols}.' + ) diff --git a/contrib/python/botocore/py3/botocore/handlers.py b/contrib/python/botocore/py3/botocore/handlers.py index 6069eea971b..bc25132edf8 100644 --- a/contrib/python/botocore/py3/botocore/handlers.py +++ b/contrib/python/botocore/py3/botocore/handlers.py @@ -62,10 +62,9 @@ from botocore.signers import ( from botocore.utils import ( SAFE_CHARS, ArnParser, - conditionally_calculate_checksum, - conditionally_calculate_md5, percent_encode, switch_host_with_param, + conditionally_calculate_md5, ) # Keep these imported. There's pre-existing code that uses them. @@ -1315,6 +1314,33 @@ def add_query_compatibility_header(model, params, **kwargs): params['headers']['x-amzn-query-mode'] = 'true' +def _handle_request_validation_mode_member(params, model, **kwargs): + client_config = kwargs.get("context", {}).get("client_config") + if client_config is None: + return + response_checksum_validation = client_config.response_checksum_validation + http_checksum = model.http_checksum + mode_member = http_checksum.get("requestValidationModeMember") + if ( + mode_member is not None + and response_checksum_validation == "when_supported" + ): + params.setdefault(mode_member, "ENABLED") + + +def _set_extra_headers_for_unsigned_request( + request, signature_version, **kwargs +): + # When sending a checksum in the trailer of an unsigned chunked request, S3 + # requires us to set the "X-Amz-Content-SHA256" header to "STREAMING-UNSIGNED-PAYLOAD-TRAILER". + checksum_context = request.context.get("checksum", {}) + algorithm = checksum_context.get("request_algorithm", {}) + in_trailer = algorithm.get("in") == "trailer" + headers = request.headers + if signature_version == botocore.UNSIGNED and in_trailer: + headers["X-Amz-Content-SHA256"] = "STREAMING-UNSIGNED-PAYLOAD-TRAILER" + + # This is a list of (event_name, handler). # When a Session is created, everything in this list will be # automatically registered with that Session. @@ -1352,6 +1378,7 @@ BUILTIN_HANDLERS = [ ('before-parse.s3.*', handle_expires_header), ('before-parse.s3.*', _handle_200_error, REGISTER_FIRST), ('before-parameter-build', generate_idempotent_uuid), + ('before-parameter-build', _handle_request_validation_mode_member), ('before-parameter-build.s3', validate_bucket_name), ('before-parameter-build.s3', remove_bucket_from_url_paths_from_model), ( @@ -1385,11 +1412,8 @@ BUILTIN_HANDLERS = [ ('before-call.s3', add_expect_header), ('before-call.glacier', add_glacier_version), ('before-call.apigateway', add_accept_header), - ('before-call.s3.PutObject', conditionally_calculate_checksum), ('before-call.s3.PatchObject', conditionally_calculate_md5), - ('before-call.s3.UploadPart', conditionally_calculate_md5), ('before-call.s3.DeleteObjects', escape_xml_payload), - ('before-call.s3.DeleteObjects', conditionally_calculate_checksum), ('before-call.s3.PutBucketLifecycleConfiguration', escape_xml_payload), ('before-call.glacier.UploadArchive', add_glacier_checksums), ('before-call.glacier.UploadMultipartPart', add_glacier_checksums), @@ -1427,6 +1451,7 @@ BUILTIN_HANDLERS = [ ('before-parameter-build.route53', fix_route53_ids), ('before-parameter-build.glacier', inject_account_id), ('before-sign.s3', remove_arn_from_signing_path), + ('before-sign.s3', _set_extra_headers_for_unsigned_request), ( 'before-sign.polly.SynthesizeSpeech', remove_content_type_header_for_presigning, diff --git a/contrib/python/botocore/py3/botocore/httpchecksum.py b/contrib/python/botocore/py3/botocore/httpchecksum.py index a97eb430d48..929e147e1e0 100644 --- a/contrib/python/botocore/py3/botocore/httpchecksum.py +++ b/contrib/python/botocore/py3/botocore/httpchecksum.py @@ -25,16 +25,18 @@ import logging from binascii import crc32 from hashlib import sha1, sha256 -from botocore.compat import HAS_CRT +from botocore.compat import HAS_CRT, has_minimum_crt_version, urlparse from botocore.exceptions import ( AwsChunkedWrapperError, FlexibleChecksumError, MissingDependencyException, ) +from botocore.model import StructureShape from botocore.response import StreamingBody from botocore.utils import ( conditionally_calculate_md5, determine_content_length, + has_checksum_header, ) if HAS_CRT: @@ -44,6 +46,8 @@ else: logger = logging.getLogger(__name__) +DEFAULT_CHECKSUM_ALGORITHM = "CRC32" + class BaseChecksum: _CHUNK_SIZE = 1024 * 1024 @@ -109,6 +113,19 @@ class CrtCrc32cChecksum(BaseChecksum): return self._int_crc32c.to_bytes(4, byteorder="big") +class CrtCrc64NvmeChecksum(BaseChecksum): + # Note: This class is only used if the CRT is available + def __init__(self): + self._int_crc64nvme = 0 + + def update(self, chunk): + new_checksum = crt_checksums.crc64nvme(chunk, self._int_crc64nvme) + self._int_crc64nvme = new_checksum & 0xFFFFFFFFFFFFFFFF + + def digest(self): + return self._int_crc64nvme.to_bytes(8, byteorder="big") + + class Sha1Checksum(BaseChecksum): def __init__(self): self._checksum = sha1() @@ -246,7 +263,19 @@ def resolve_request_checksum_algorithm( params, supported_algorithms=None, ): + # If the header is already set by the customer, skip calculation + if has_checksum_header(request): + return + + checksum_context = request["context"].get("checksum", {}) + request_checksum_calculation = request["context"][ + "client_config" + ].request_checksum_calculation http_checksum = operation_model.http_checksum + request_checksum_required = ( + operation_model.http_checksum_required + or http_checksum.get("requestChecksumRequired") + ) algorithm_member = http_checksum.get("requestAlgorithmMember") if algorithm_member and algorithm_member in params: # If the client has opted into using flexible checksums and the @@ -267,35 +296,59 @@ def resolve_request_checksum_algorithm( raise FlexibleChecksumError( error_msg=f"Unsupported checksum algorithm: {algorithm_name}" ) + elif request_checksum_required or ( + algorithm_member and request_checksum_calculation == "when_supported" + ): + # Don't use a default checksum for presigned requests. + if request["context"].get("is_presign_request"): + return + algorithm_name = DEFAULT_CHECKSUM_ALGORITHM.lower() + algorithm_member_header = _get_request_algorithm_member_header( + operation_model, request, algorithm_member + ) + if algorithm_member_header is not None: + checksum_context["request_algorithm_header"] = { + "name": algorithm_member_header, + "value": DEFAULT_CHECKSUM_ALGORITHM, + } + else: + return - location_type = "header" - if operation_model.has_streaming_input: + location_type = "header" + if ( + operation_model.has_streaming_input + and urlparse(request["url"]).scheme == "https" + ): + if request["context"]["client_config"].signature_version != 's3': # Operations with streaming input must support trailers. - if request["url"].startswith("https:"): - # We only support unsigned trailer checksums currently. As this - # disables payload signing we'll only use trailers over TLS. - location_type = "trailer" + # We only support unsigned trailer checksums currently. As this + # disables payload signing we'll only use trailers over TLS. + location_type = "trailer" - algorithm = { - "algorithm": algorithm_name, - "in": location_type, - "name": f"x-amz-checksum-{algorithm_name}", - } + algorithm = { + "algorithm": algorithm_name, + "in": location_type, + "name": f"x-amz-checksum-{algorithm_name}", + } - if algorithm["name"] in request["headers"]: - # If the header is already set by the customer, skip calculation - return + checksum_context["request_algorithm"] = algorithm + request["context"]["checksum"] = checksum_context - checksum_context = request["context"].get("checksum", {}) - checksum_context["request_algorithm"] = algorithm - request["context"]["checksum"] = checksum_context - elif operation_model.http_checksum_required or http_checksum.get( - "requestChecksumRequired" - ): - # Otherwise apply the old http checksum behavior via Content-MD5 - checksum_context = request["context"].get("checksum", {}) - checksum_context["request_algorithm"] = "conditional-md5" - request["context"]["checksum"] = checksum_context + +def _get_request_algorithm_member_header( + operation_model, request, algorithm_member +): + """Get the name of the header targeted by the "requestAlgorithmMember".""" + operation_input_shape = operation_model.input_shape + if not isinstance(operation_input_shape, StructureShape): + return + + algorithm_member_shape = operation_input_shape.members.get( + algorithm_member + ) + + if algorithm_member_shape: + return algorithm_member_shape.serialization.get("name") def apply_request_checksum(request): @@ -316,6 +369,11 @@ def apply_request_checksum(request): raise FlexibleChecksumError( error_msg="Unknown checksum variant: {}".format(algorithm["in"]) ) + if "request_algorithm_header" in checksum_context: + request_algorithm_header = checksum_context["request_algorithm_header"] + request["headers"][request_algorithm_header["name"]] = ( + request_algorithm_header["value"] + ) def _apply_request_header_checksum(request): @@ -358,6 +416,12 @@ def _apply_request_trailer_checksum(request): # services such as S3 may require the decoded content length headers["X-Amz-Decoded-Content-Length"] = str(content_length) + if "Content-Length" in headers: + del headers["Content-Length"] + logger.debug( + "Removing the Content-Length header since 'chunked' is specified for Transfer-Encoding." + ) + if isinstance(body, (bytes, bytearray)): body = io.BytesIO(body) @@ -427,7 +491,7 @@ def handle_checksum_body(http_response, response, context, operation_model): response["context"]["checksum"] = checksum_context return - logger.info( + logger.debug( f'Skipping checksum validation. Response did not contain one of the ' f'following algorithms: {algorithms}.' ) @@ -465,17 +529,22 @@ _CHECKSUM_CLS = { "sha1": Sha1Checksum, "sha256": Sha256Checksum, } -_CRT_CHECKSUM_ALGORITHMS = ["crc32", "crc32c"] +_CRT_CHECKSUM_ALGORITHMS = ["crc32", "crc32c", "crc64nvme"] if HAS_CRT: # Use CRT checksum implementations if available _CRT_CHECKSUM_CLS = { "crc32": CrtCrc32Checksum, "crc32c": CrtCrc32cChecksum, } + + if has_minimum_crt_version((0, 23, 4)): + # CRC64NVME support wasn't officially added until 0.23.4 + _CRT_CHECKSUM_CLS["crc64nvme"] = CrtCrc64NvmeChecksum + _CHECKSUM_CLS.update(_CRT_CHECKSUM_CLS) # Validate this list isn't out of sync with _CRT_CHECKSUM_CLS keys assert all( name in _CRT_CHECKSUM_ALGORITHMS for name in _CRT_CHECKSUM_CLS.keys() ) _SUPPORTED_CHECKSUM_ALGORITHMS = list(_CHECKSUM_CLS.keys()) -_ALGORITHMS_PRIORITY_LIST = ['crc32c', 'crc32', 'sha1', 'sha256'] +_ALGORITHMS_PRIORITY_LIST = ['crc64nvme', 'crc32c', 'crc32', 'sha1', 'sha256'] diff --git a/contrib/python/botocore/py3/botocore/model.py b/contrib/python/botocore/py3/botocore/model.py index efd15e90e7f..263aa5483c6 100644 --- a/contrib/python/botocore/py3/botocore/model.py +++ b/contrib/python/botocore/py3/botocore/model.py @@ -423,6 +423,10 @@ class ServiceModel: return self._get_metadata_property('protocol') @CachedProperty + def protocols(self): + return self._get_metadata_property('protocols') + + @CachedProperty def endpoint_prefix(self): return self._get_metadata_property('endpointPrefix') diff --git a/contrib/python/botocore/py3/botocore/parsers.py b/contrib/python/botocore/py3/botocore/parsers.py index 0c7a34f2188..3b5d823f3d7 100644 --- a/contrib/python/botocore/py3/botocore/parsers.py +++ b/contrib/python/botocore/py3/botocore/parsers.py @@ -124,6 +124,7 @@ import re from botocore.compat import ETree, XMLParseError from botocore.eventstream import EventStream, NoInitialResponseError from botocore.utils import ( + ensure_boolean, is_json_value_header, lowercase_dict, merge_dicts, @@ -356,6 +357,9 @@ class ResponseParser: if shape.is_tagged_union: cleaned_value = value.copy() cleaned_value.pop("__type", None) + cleaned_value = { + k: v for k, v in cleaned_value.items() if v is not None + } if len(cleaned_value) != 1: error_msg = ( "Invalid service response: %s must have one and only " @@ -363,7 +367,11 @@ class ResponseParser: ) raise ResponseParserError(error_msg % shape.name) tag = self._get_first_key(cleaned_value) - if tag not in shape.members: + serialized_member_names = [ + shape.members[member].serialization.get('name', member) + for member in shape.members + ] + if tag not in serialized_member_names: msg = ( "Received a tagged union response with member " "unknown to client: %s. Please upgrade SDK for full " @@ -707,6 +715,8 @@ class BaseJSONParser(ResponseParser): # code has a couple forms as well: # * "com.aws.dynamodb.vAPI#ProvisionedThroughputExceededException" # * "ResourceNotFoundException" + if ':' in code: + code = code.split(':', 1)[0] if '#' in code: code = code.rsplit('#', 1)[1] if 'x-amzn-query-error' in headers: @@ -1020,19 +1030,29 @@ class RestJSONParser(BaseRestParser, BaseJSONParser): # The "Code" value can come from either a response # header or a value in the JSON body. body = self._initial_body_parse(response['body']) + code = None if 'x-amzn-errortype' in response['headers']: code = response['headers']['x-amzn-errortype'] - # Could be: - # x-amzn-errortype: ValidationException: - code = code.split(':')[0] - error['Error']['Code'] = code elif 'code' in body or 'Code' in body: - error['Error']['Code'] = body.get('code', body.get('Code', '')) + code = body.get('code', body.get('Code', '')) + if code is not None: + if ':' in code: + code = code.split(':', 1)[0] + if '#' in code: + code = code.rsplit('#', 1)[1] + error['Error']['Code'] = code + + def _handle_boolean(self, shape, value): + return ensure_boolean(value) def _handle_integer(self, shape, value): return int(value) + def _handle_float(self, shape, value): + return float(value) + _handle_long = _handle_integer + _handle_double = _handle_float class RestXMLParser(BaseRestParser, BaseXMLResponseParser): diff --git a/contrib/python/botocore/py3/botocore/utils.py b/contrib/python/botocore/py3/botocore/utils.py index 86ebde80fe8..30a513ea901 100644 --- a/contrib/python/botocore/py3/botocore/utils.py +++ b/contrib/python/botocore/py3/botocore/utils.py @@ -3228,6 +3228,7 @@ def get_encoding_from_headers(headers, default='ISO-8859-1'): def calculate_md5(body, **kwargs): + """This function has been deprecated, but is kept for backwards compatibility.""" if isinstance(body, (bytes, bytearray)): binary_md5 = _calculate_md5_from_bytes(body) else: @@ -3236,11 +3237,13 @@ def calculate_md5(body, **kwargs): def _calculate_md5_from_bytes(body_bytes): + """This function has been deprecated, but is kept for backwards compatibility.""" md5 = get_md5(body_bytes) return md5.digest() def _calculate_md5_from_file(fileobj): + """This function has been deprecated, but is kept for backwards compatibility.""" start_position = fileobj.tell() md5 = get_md5() for chunk in iter(lambda: fileobj.read(1024 * 1024), b''): @@ -3256,15 +3259,17 @@ def _is_s3express_request(params): return endpoint_properties.get('backend') == 'S3Express' -def _has_checksum_header(params): +def has_checksum_header(params): + """ + Checks if a header starting with "x-amz-checksum-" is provided in a request. + + This function is considered private and subject to abrupt breaking changes or + removal without prior announcement. Please do not use it directly. + """ headers = params['headers'] - # If a user provided Content-MD5 is present, - # don't try to compute a new one. - if 'Content-MD5' in headers: - return True # If a header matching the x-amz-checksum-* pattern is present, we - # assume a checksum has already been provided and an md5 is not needed + # assume a checksum has already been provided by the user. for header in headers: if CHECKSUM_HEADER_PATTERN.match(header): return True @@ -3273,12 +3278,14 @@ def _has_checksum_header(params): def conditionally_calculate_checksum(params, **kwargs): - if not _has_checksum_header(params): + """This function has been deprecated, but is kept for backwards compatibility.""" + if not has_checksum_header(params): conditionally_calculate_md5(params, **kwargs) conditionally_enable_crc32(params, **kwargs) def conditionally_enable_crc32(params, **kwargs): + """This function has been deprecated, but is kept for backwards compatibility.""" checksum_context = params.get('context', {}).get('checksum', {}) checksum_algorithm = checksum_context.get('request_algorithm') if ( @@ -3296,7 +3303,10 @@ def conditionally_enable_crc32(params, **kwargs): def conditionally_calculate_md5(params, **kwargs): - """Only add a Content-MD5 if the system supports it.""" + """Only add a Content-MD5 if the system supports it. + + This function has been deprecated, but is kept for backwards compatibility. + """ body = params['body'] checksum_context = params.get('context', {}).get('checksum', {}) checksum_algorithm = checksum_context.get('request_algorithm') @@ -3304,7 +3314,7 @@ def conditionally_calculate_md5(params, **kwargs): # Skip for requests that will have a flexible checksum applied return - if _has_checksum_header(params): + if has_checksum_header(params): # Don't add a new header if one is already available. return diff --git a/contrib/python/botocore/py3/patches/02-fix-for-arcadia.patch b/contrib/python/botocore/py3/patches/02-fix-for-arcadia.patch index bf8f74218a8..dc0c798bad3 100644 --- a/contrib/python/botocore/py3/patches/02-fix-for-arcadia.patch +++ b/contrib/python/botocore/py3/patches/02-fix-for-arcadia.patch @@ -1,9 +1,9 @@ --- contrib/python/botocore/py3/botocore/data/endpoints.json (index) +++ contrib/python/botocore/py3/botocore/data/endpoints.json (working tree) @@ -21165,6 +21165,46 @@ - "regionRegex" : "^eu\\-isoe\\-\\w+\\-\\d+$", - "regions" : { }, - "services" : { } + } + } + } + }, { + "defaults" : { + "hostname" : "{service}.{region}.{dnsSuffix}", diff --git a/contrib/python/botocore/py3/patches/04-add-patch-method.patch b/contrib/python/botocore/py3/patches/04-add-patch-method.patch index ad7b1044e4a..1843c2aaed0 100644 --- a/contrib/python/botocore/py3/patches/04-add-patch-method.patch +++ b/contrib/python/botocore/py3/patches/04-add-patch-method.patch @@ -101,6 +101,14 @@ "members":{ --- contrib/python/botocore/py3/botocore/handlers.py (5718cbe7c8ad633beee9e1eac79e295dea4b8966) +++ contrib/python/botocore/py3/botocore/handlers.py (0f7e89156b6ce9f3947ef47273baefe09dd0c1ad) +@@ -64,6 +64,7 @@ from botocore.utils import ( + ArnParser, + percent_encode, + switch_host_with_param, ++ conditionally_calculate_md5, + ) + + # Keep these imported. There's pre-existing code that uses them. @@ -1173,6 +1194,11 @@ BUILTIN_HANDLERS = [ convert_body_to_file_like_object, REGISTER_LAST, @@ -114,13 +122,13 @@ ('creating-client-class.s3', add_generate_presigned_post), ('creating-client-class.iot-data', check_openssl_supports_tls_version_1_2), @@ -1213,6 +1239,7 @@ BUILTIN_HANDLERS = [ + ('before-call.s3', add_expect_header), ('before-call.glacier', add_glacier_version), ('before-call.apigateway', add_accept_header), - ('before-call.s3.PutObject', conditionally_calculate_checksum), + ('before-call.s3.PatchObject', conditionally_calculate_md5), - ('before-call.s3.UploadPart', conditionally_calculate_md5), ('before-call.s3.DeleteObjects', escape_xml_payload), - ('before-call.s3.DeleteObjects', conditionally_calculate_checksum), + ('before-call.s3.PutBucketLifecycleConfiguration', escape_xml_payload), + ('before-call.glacier.UploadArchive', add_glacier_checksums), @@ -1242,6 +1269,7 @@ BUILTIN_HANDLERS = [ ('before-parameter-build.s3.HeadObject', sse_md5), ('before-parameter-build.s3.GetObject', sse_md5), diff --git a/contrib/python/botocore/py3/ya.make b/contrib/python/botocore/py3/ya.make index cbc02d65835..c9994a2bbd6 100644 --- a/contrib/python/botocore/py3/ya.make +++ b/contrib/python/botocore/py3/ya.make @@ -2,7 +2,7 @@ PY3_LIBRARY() -VERSION(1.35.99) +VERSION(1.36.26) LICENSE(Apache-2.0) @@ -1298,6 +1298,7 @@ RESOURCE_FILES( botocore/data/network-firewall/2020-11-12/endpoint-rule-set-1.json botocore/data/network-firewall/2020-11-12/examples-1.json botocore/data/network-firewall/2020-11-12/paginators-1.json + botocore/data/network-firewall/2020-11-12/paginators-1.sdk-extras.json botocore/data/network-firewall/2020-11-12/service-2.json botocore/data/networkflowmonitor/2023-04-19/endpoint-rule-set-1.json botocore/data/networkflowmonitor/2023-04-19/paginators-1.json @@ -1338,6 +1339,7 @@ RESOURCE_FILES( botocore/data/opensearchserverless/2021-11-01/endpoint-rule-set-1.json botocore/data/opensearchserverless/2021-11-01/paginators-1.json botocore/data/opensearchserverless/2021-11-01/service-2.json + botocore/data/opensearchserverless/2021-11-01/waiters-2.json botocore/data/opsworks/2013-02-18/endpoint-rule-set-1.json botocore/data/opsworks/2013-02-18/examples-1.json botocore/data/opsworks/2013-02-18/paginators-1.json |