New upstream version 1.15.26+repack
This commit is contained in:
TANIGUCHI Takaki
parent
a332cfe450
commit
5762630096
2
PKG-INFO
2
PKG-INFO
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 1.14.14
|
||||
Version: 1.15.26
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Amazon Web Services
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 1.14.14
|
||||
Version: 1.15.26
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Amazon Web Services
|
||||
|
|
|
|||
|
|
@ -709,6 +709,14 @@ botocore/docs/bcdoc/docstringparser.py
|
|||
botocore/docs/bcdoc/restdoc.py
|
||||
botocore/docs/bcdoc/style.py
|
||||
botocore/docs/bcdoc/textwriter.py
|
||||
botocore/retries/__init__.py
|
||||
botocore/retries/adaptive.py
|
||||
botocore/retries/base.py
|
||||
botocore/retries/bucket.py
|
||||
botocore/retries/quota.py
|
||||
botocore/retries/special.py
|
||||
botocore/retries/standard.py
|
||||
botocore/retries/throttling.py
|
||||
botocore/vendored/__init__.py
|
||||
botocore/vendored/six.py
|
||||
botocore/vendored/requests/__init__.py
|
||||
|
|
@ -856,6 +864,9 @@ tests/functional/models/custom-acm/2015-12-08/examples-1.json
|
|||
tests/functional/models/custom-acm/2015-12-08/paginators-1.json
|
||||
tests/functional/models/custom-acm/2015-12-08/service-2.json
|
||||
tests/functional/models/custom-acm/2015-12-08/waiters-2.json
|
||||
tests/functional/retries/__init__.py
|
||||
tests/functional/retries/test_bucket.py
|
||||
tests/functional/retries/test_quota.py
|
||||
tests/functional/utils/__init__.py
|
||||
tests/functional/utils/credentialprocess.py
|
||||
tests/integration/__init__.py
|
||||
|
|
@ -1601,4 +1612,11 @@ tests/unit/response_parsing/xml/responses/sqs-send-message-batch.xml
|
|||
tests/unit/response_parsing/xml/responses/sqs-send-message.json
|
||||
tests/unit/response_parsing/xml/responses/sqs-send-message.xml
|
||||
tests/unit/response_parsing/xml/responses/sts-get-session-token.json
|
||||
tests/unit/response_parsing/xml/responses/sts-get-session-token.xml
|
||||
tests/unit/response_parsing/xml/responses/sts-get-session-token.xml
|
||||
tests/unit/retries/__init__.py
|
||||
tests/unit/retries/test_adaptive.py
|
||||
tests/unit/retries/test_bucket.py
|
||||
tests/unit/retries/test_quota.py
|
||||
tests/unit/retries/test_special.py
|
||||
tests/unit/retries/test_standard.py
|
||||
tests/unit/retries/test_throttling.py
|
||||
|
|
@ -16,7 +16,7 @@ import os
|
|||
import re
|
||||
import logging
|
||||
|
||||
__version__ = '1.14.14'
|
||||
__version__ = '1.15.26'
|
||||
|
||||
|
||||
class NullHandler(logging.Handler):
|
||||
|
|
|
|||
|
|
@ -169,6 +169,7 @@ class ClientArgsCreator(object):
|
|||
client_cert=client_config.client_cert,
|
||||
inject_host_prefix=client_config.inject_host_prefix,
|
||||
)
|
||||
self._compute_retry_config(config_kwargs)
|
||||
s3_config = self.compute_s3_config(client_config)
|
||||
return {
|
||||
'service_name': service_name,
|
||||
|
|
@ -310,6 +311,56 @@ class ClientArgsCreator(object):
|
|||
(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1))
|
||||
return socket_options
|
||||
|
||||
def _compute_retry_config(self, config_kwargs):
|
||||
self._compute_retry_max_attempts(config_kwargs)
|
||||
self._compute_retry_mode(config_kwargs)
|
||||
|
||||
def _compute_retry_max_attempts(self, config_kwargs):
|
||||
# There's a pre-existing max_attempts client config value that actually
|
||||
# means max *retry* attempts. There's also a `max_attempts` we pull
|
||||
# from the config store that means *total attempts*, which includes the
|
||||
# intitial request. We can't change what `max_attempts` means in
|
||||
# client config so we try to normalize everything to a new
|
||||
# "total_max_attempts" variable. We ensure that after this, the only
|
||||
# configuration for "max attempts" is the 'total_max_attempts' key.
|
||||
# An explicitly provided max_attempts in the client config
|
||||
# overrides everything.
|
||||
retries = config_kwargs.get('retries')
|
||||
if retries is not None:
|
||||
if 'total_max_attempts' in retries:
|
||||
retries.pop('max_attempts', None)
|
||||
return
|
||||
if 'max_attempts' in retries:
|
||||
value = retries.pop('max_attempts')
|
||||
# client config max_attempts means total retries so we
|
||||
# have to add one for 'total_max_attempts' to account
|
||||
# for the initial request.
|
||||
retries['total_max_attempts'] = value + 1
|
||||
return
|
||||
# Otherwise we'll check the config store which checks env vars,
|
||||
# config files, etc. There is no default value for max_attempts
|
||||
# so if this returns None and we don't set a default value here.
|
||||
max_attempts = self._config_store.get_config_variable('max_attempts')
|
||||
if max_attempts is not None:
|
||||
if retries is None:
|
||||
retries = {}
|
||||
config_kwargs['retries'] = retries
|
||||
retries['total_max_attempts'] = max_attempts
|
||||
|
||||
def _compute_retry_mode(self, config_kwargs):
|
||||
retries = config_kwargs.get('retries')
|
||||
if retries is None:
|
||||
retries = {}
|
||||
config_kwargs['retries'] = retries
|
||||
elif 'mode' in retries:
|
||||
# If there's a retry mode explicitly set in the client config
|
||||
# that overrides everything.
|
||||
return
|
||||
retry_mode = self._config_store.get_config_variable('retry_mode')
|
||||
if retry_mode is None:
|
||||
retry_mode = 'legacy'
|
||||
retries['mode'] = retry_mode
|
||||
|
||||
def _ensure_boolean(self, val):
|
||||
if isinstance(val, bool):
|
||||
return val
|
||||
|
|
|
|||
|
|
@ -39,6 +39,8 @@ from botocore.discovery import (
|
|||
EndpointDiscoveryHandler, EndpointDiscoveryManager,
|
||||
block_endpoint_discovery_required_operations
|
||||
)
|
||||
from botocore.retries import standard
|
||||
from botocore.retries import adaptive
|
||||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
|
@ -116,6 +118,26 @@ class ClientCreator(object):
|
|||
return service_model
|
||||
|
||||
def _register_retries(self, client):
|
||||
retry_mode = client.meta.config.retries['mode']
|
||||
if retry_mode == 'standard':
|
||||
self._register_v2_standard_retries(client)
|
||||
elif retry_mode == 'adaptive':
|
||||
self._register_v2_standard_retries(client)
|
||||
self._register_v2_adaptive_retries(client)
|
||||
elif retry_mode == 'legacy':
|
||||
self._register_legacy_retries(client)
|
||||
|
||||
def _register_v2_standard_retries(self, client):
|
||||
max_attempts = client.meta.config.retries.get('total_max_attempts')
|
||||
kwargs = {'client': client}
|
||||
if max_attempts is not None:
|
||||
kwargs['max_attempts'] = max_attempts
|
||||
standard.register_retry_handler(**kwargs)
|
||||
|
||||
def _register_v2_adaptive_retries(self, client):
|
||||
adaptive.register_retry_handler(client)
|
||||
|
||||
def _register_legacy_retries(self, client):
|
||||
endpoint_prefix = client.meta.service_model.endpoint_prefix
|
||||
service_id = client.meta.service_model.service_id
|
||||
service_event_name = service_id.hyphenize()
|
||||
|
|
@ -126,10 +148,11 @@ class ClientCreator(object):
|
|||
if not original_config:
|
||||
return
|
||||
|
||||
retries = self._transform_legacy_retries(client.meta.config.retries)
|
||||
retry_config = self._retry_config_translator.build_retry_config(
|
||||
endpoint_prefix, original_config.get('retry', {}),
|
||||
original_config.get('definitions', {}),
|
||||
client.meta.config.retries
|
||||
retries
|
||||
)
|
||||
|
||||
logger.debug("Registering retry handlers for service: %s",
|
||||
|
|
@ -142,6 +165,23 @@ class ClientCreator(object):
|
|||
unique_id=unique_id
|
||||
)
|
||||
|
||||
def _transform_legacy_retries(self, retries):
|
||||
if retries is None:
|
||||
return
|
||||
copied_args = retries.copy()
|
||||
if 'total_max_attempts' in retries:
|
||||
copied_args = retries.copy()
|
||||
copied_args['max_attempts'] = (
|
||||
copied_args.pop('total_max_attempts') - 1)
|
||||
return copied_args
|
||||
|
||||
def _get_retry_mode(self, client, config_store):
|
||||
client_retries = client.meta.config.retries
|
||||
if client_retries is not None and \
|
||||
client_retries.get('mode') is not None:
|
||||
return client_retries['mode']
|
||||
return config_store.get_config_variable('retry_mode') or 'legacy'
|
||||
|
||||
def _register_endpoint_discovery(self, client, endpoint_url, config):
|
||||
if endpoint_url is not None:
|
||||
# Don't register any handlers in the case of a custom endpoint url
|
||||
|
|
|
|||
|
|
@ -23,6 +23,7 @@ from math import floor
|
|||
|
||||
from botocore.vendored import six
|
||||
from botocore.exceptions import MD5UnavailableError
|
||||
from dateutil.tz import tzlocal
|
||||
from urllib3 import exceptions
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
|
@ -329,6 +330,17 @@ def _windows_shell_split(s):
|
|||
return components
|
||||
|
||||
|
||||
def get_tzinfo_options():
|
||||
# Due to dateutil/dateutil#197, Windows may fail to parse times in the past
|
||||
# with the system clock. We can alternatively fallback to tzwininfo when
|
||||
# this happens, which will get time info from the Windows registry.
|
||||
if sys.platform == 'win32':
|
||||
from dateutil.tz import tzwinlocal
|
||||
return (tzlocal, tzwinlocal)
|
||||
else:
|
||||
return (tzlocal,)
|
||||
|
||||
|
||||
try:
|
||||
from collections.abc import MutableMapping
|
||||
except ImportError:
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ from botocore.endpoint import DEFAULT_TIMEOUT, MAX_POOL_CONNECTIONS
|
|||
from botocore.exceptions import InvalidS3AddressingStyleError
|
||||
from botocore.exceptions import InvalidRetryConfigurationError
|
||||
from botocore.exceptions import InvalidMaxRetryAttemptsError
|
||||
from botocore.exceptions import InvalidRetryModeError
|
||||
|
||||
|
||||
class Config(object):
|
||||
|
|
@ -107,6 +108,14 @@ class Config(object):
|
|||
:param retries: A dictionary for retry specific configurations.
|
||||
Valid keys are:
|
||||
|
||||
* 'total_max_attempts' -- An integer representing the maximum number of
|
||||
total attempts that will be made on a single request. This includes
|
||||
the initial request, so a value of 1 indicates that no requests
|
||||
will be retried. If ``total_max_attempts`` and ``max_attempts``
|
||||
are both provided, ``total_max_attempts`` takes precedence.
|
||||
``total_max_attempts`` is preferred over ``max_attempts`` because
|
||||
it maps to the ``AWS_MAX_ATTEMPTS`` environment variable and
|
||||
the ``max_attempts`` config file value.
|
||||
* 'max_attempts' -- An integer representing the maximum number of
|
||||
retry attempts that will be made on a single request. For
|
||||
example, setting this value to 2 will result in the request
|
||||
|
|
@ -114,6 +123,12 @@ class Config(object):
|
|||
this value to 0 will result in no retries ever being attempted on
|
||||
the initial request. If not provided, the number of retries will
|
||||
default to whatever is modeled, which is typically four retries.
|
||||
* 'mode' -- A string representing the type of retry mode botocore
|
||||
should use. Valid values are:
|
||||
* ``legacy`` - The pre-existing retry behavior.
|
||||
* ``standard`` - The standardized set of retry rules. This
|
||||
will also default to 3 max attempts unless overridden.
|
||||
* ``adaptive`` - Retries with additional client side throttling.
|
||||
|
||||
:type client_cert: str, (str, str)
|
||||
:param client_cert: The path to a certificate for TLS client authentication.
|
||||
|
|
@ -211,13 +226,24 @@ class Config(object):
|
|||
|
||||
def _validate_retry_configuration(self, retries):
|
||||
if retries is not None:
|
||||
for key in retries:
|
||||
if key not in ['max_attempts']:
|
||||
for key, value in retries.items():
|
||||
if key not in ['max_attempts', 'mode', 'total_max_attempts']:
|
||||
raise InvalidRetryConfigurationError(
|
||||
retry_config_option=key)
|
||||
if key == 'max_attempts' and retries[key] < 0:
|
||||
if key == 'max_attempts' and value < 0:
|
||||
raise InvalidMaxRetryAttemptsError(
|
||||
provided_max_attempts=retries[key]
|
||||
provided_max_attempts=value,
|
||||
min_value=0,
|
||||
)
|
||||
if key == 'total_max_attempts' and value < 1:
|
||||
raise InvalidMaxRetryAttemptsError(
|
||||
provided_max_attempts=value,
|
||||
min_value=1,
|
||||
)
|
||||
if key == 'mode' and value not in ['legacy', 'standard',
|
||||
'adaptive']:
|
||||
raise InvalidRetryModeError(
|
||||
provided_retry_mode=value
|
||||
)
|
||||
|
||||
def merge(self, other_config):
|
||||
|
|
|
|||
|
|
@ -88,7 +88,10 @@ BOTOCORE_DEFAUT_SESSION_VARIABLES = {
|
|||
'sts_regional_endpoints', 'AWS_STS_REGIONAL_ENDPOINTS', 'legacy',
|
||||
None
|
||||
),
|
||||
|
||||
'retry_mode': ('retry_mode', 'AWS_RETRY_MODE', 'legacy', None),
|
||||
# We can't have a default here for v1 because we need to defer to
|
||||
# whatever the defaults are in _retry.json.
|
||||
'max_attempts': ('max_attempts', 'AWS_MAX_ATTEMPTS', None, int),
|
||||
}
|
||||
# A mapping for the s3 specific configuration vars. These are the configuration
|
||||
# vars that typically go in the s3 section of the config file. This mapping
|
||||
|
|
|
|||
|
|
@ -162,6 +162,14 @@
|
|||
"http_status_code": 503
|
||||
}
|
||||
}
|
||||
},
|
||||
"ec2_throttled_exception": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"service_error_code": "EC2ThrottledException",
|
||||
"http_status_code": 503
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,3 +1,28 @@
|
|||
{
|
||||
"pagination": {}
|
||||
"pagination": {
|
||||
"ListAnalyzedResources": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"result_key": "analyzedResources"
|
||||
},
|
||||
"ListAnalyzers": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"result_key": "analyzers"
|
||||
},
|
||||
"ListArchiveRules": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"result_key": "archiveRules"
|
||||
},
|
||||
"ListFindings": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"result_key": "findings"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -86,7 +86,7 @@
|
|||
{"shape":"RequestInProgressException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.</p>"
|
||||
"documentation":"<p>Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use <a href=\"https://wiki.openssl.org/index.php/Command_Line_Utilities\">OpenSSL</a> to decode the certificates and inspect individual fields.</p>"
|
||||
},
|
||||
"ImportCertificate":{
|
||||
"name":"ImportCertificate",
|
||||
|
|
@ -498,7 +498,7 @@
|
|||
},
|
||||
"ResourceRecord":{
|
||||
"shape":"ResourceRecord",
|
||||
"documentation":"<p>Contains the CNAME record that you add to your DNS database for domain validation. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html\">Use DNS to Validate Domain Ownership</a>.</p>"
|
||||
"documentation":"<p>Contains the CNAME record that you add to your DNS database for domain validation. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html\">Use DNS to Validate Domain Ownership</a>.</p> <p>Note: The CNAME information that you need does not include the name of your domain. If you include
 your domain name in the DNS database CNAME record, validation fails.
 For example, if the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only \"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.</p>"
|
||||
},
|
||||
"ValidationMethod":{
|
||||
"shape":"ValidationMethod",
|
||||
|
|
@ -664,11 +664,11 @@
|
|||
"members":{
|
||||
"Certificate":{
|
||||
"shape":"CertificateBody",
|
||||
"documentation":"<p>String that contains the ACM certificate represented by the ARN specified at input.</p>"
|
||||
"documentation":"<p>The ACM-issued certificate corresponding to the ARN specified as input.</p>"
|
||||
},
|
||||
"CertificateChain":{
|
||||
"shape":"CertificateChain",
|
||||
"documentation":"<p>The certificate chain that contains the root certificate issued by the certificate authority (CA).</p>"
|
||||
"documentation":"<p>Certificates forming the requested certificate's chain of trust. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -822,7 +822,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"documentation":"<p>An ACM limit has been exceeded.</p>",
|
||||
"documentation":"<p>An ACM quota has been exceeded.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ListCertificatesRequest":{
|
||||
|
|
@ -885,7 +885,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"type":"string",
|
||||
"max":320,
|
||||
"max":10000,
|
||||
"min":1,
|
||||
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
|
||||
},
|
||||
|
|
@ -904,7 +904,7 @@
|
|||
},
|
||||
"PrivateKeyBlob":{
|
||||
"type":"blob",
|
||||
"max":524288,
|
||||
"max":5120,
|
||||
"min":1,
|
||||
"sensitive":true
|
||||
},
|
||||
|
|
@ -996,7 +996,7 @@
|
|||
},
|
||||
"SubjectAlternativeNames":{
|
||||
"shape":"DomainList",
|
||||
"documentation":"<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Limits</a>.</p> <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <ul> <li> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p> </li> <li> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.</p> </li> <li> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p> </li> </ul>"
|
||||
"documentation":"<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Quotas</a>.</p> <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <ul> <li> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p> </li> <li> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.</p> </li> <li> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p> </li> </ul>"
|
||||
},
|
||||
"IdempotencyToken":{
|
||||
"shape":"IdempotencyToken",
|
||||
|
|
|
|||
|
|
@ -154,7 +154,8 @@
|
|||
"shape" : "ConflictException",
|
||||
"documentation" : "<p>The resource already exists.</p>"
|
||||
}, {
|
||||
"shape" : "AccessDeniedException"
|
||||
"shape" : "AccessDeniedException",
|
||||
"documentation" : "<p>403 response</p>"
|
||||
} ],
|
||||
"documentation" : "<p>Creates a domain name.</p>"
|
||||
},
|
||||
|
|
@ -170,7 +171,7 @@
|
|||
},
|
||||
"output" : {
|
||||
"shape" : "CreateIntegrationResult",
|
||||
"documentation" : "\n <p>The request has succeeded and has resulted in the creation of a resource.</p>\n "
|
||||
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
|
||||
},
|
||||
"errors" : [ {
|
||||
"shape" : "NotFoundException",
|
||||
|
|
@ -257,7 +258,7 @@
|
|||
},
|
||||
"output" : {
|
||||
"shape" : "CreateRouteResult",
|
||||
"documentation" : "\n <p>The request has succeeded and has resulted in the creation of a resource.</p>\n "
|
||||
"documentation" : "<p>The request has succeeded and has resulted in the creation of a resource.</p>"
|
||||
},
|
||||
"errors" : [ {
|
||||
"shape" : "NotFoundException",
|
||||
|
|
@ -332,6 +333,48 @@
|
|||
} ],
|
||||
"documentation" : "<p>Creates a Stage for an API.</p>"
|
||||
},
|
||||
"CreateVpcLink" : {
|
||||
"name" : "CreateVpcLink",
|
||||
"http" : {
|
||||
"method" : "POST",
|
||||
"requestUri" : "/v2/vpclinks",
|
||||
"responseCode" : 201
|
||||
},
|
||||
"input" : {
|
||||
"shape" : "CreateVpcLinkRequest"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"DeleteAccessLogSettings" : {
|
||||
"name" : "DeleteAccessLogSettings",
|
||||
"http" : {
|
||||
"method" : "DELETE",
|
||||
"requestUri" : "/v2/apis/{apiId}/stages/{stageName}/accesslogsettings",
|
||||
"responseCode" : 204
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"DeleteApi" : {
|
||||
"name" : "DeleteApi",
|
||||
"http" : {
|
||||
|
|
@ -525,6 +568,25 @@
|
|||
} ],
|
||||
"documentation" : "<p>Deletes a Route.</p>"
|
||||
},
|
||||
"DeleteRouteRequestParameter" : {
|
||||
"name" : "DeleteRouteRequestParameter",
|
||||
"http" : {
|
||||
"method" : "DELETE",
|
||||
"requestUri" : "/v2/apis/{apiId}/routes/{routeId}/requestparameters/{requestParameterKey}",
|
||||
"responseCode" : 204
|
||||
},
|
||||
"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.</p>"
|
||||
},
|
||||
"DeleteRouteResponse" : {
|
||||
"name" : "DeleteRouteResponse",
|
||||
"http" : {
|
||||
|
|
@ -582,6 +644,29 @@
|
|||
} ],
|
||||
"documentation" : "<p>Deletes a Stage.</p>"
|
||||
},
|
||||
"DeleteVpcLink" : {
|
||||
"name" : "DeleteVpcLink",
|
||||
"http" : {
|
||||
"method" : "DELETE",
|
||||
"requestUri" : "/v2/vpclinks/{vpcLinkId}",
|
||||
"responseCode" : 202
|
||||
},
|
||||
"input" : {
|
||||
"shape" : "DeleteVpcLinkRequest"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"GetApi" : {
|
||||
"name" : "GetApi",
|
||||
"http" : {
|
||||
|
|
@ -842,7 +927,7 @@
|
|||
},
|
||||
"output" : {
|
||||
"shape" : "GetIntegrationResult",
|
||||
"documentation" : "\n <p>Success</p>\n "
|
||||
"documentation" : "<p>Success</p>"
|
||||
},
|
||||
"errors" : [ {
|
||||
"shape" : "NotFoundException",
|
||||
|
|
@ -1012,7 +1097,7 @@
|
|||
},
|
||||
"output" : {
|
||||
"shape" : "GetRouteResult",
|
||||
"documentation" : "\n <p>Success</p>\n "
|
||||
"documentation" : "<p>Success</p>"
|
||||
},
|
||||
"errors" : [ {
|
||||
"shape" : "NotFoundException",
|
||||
|
|
@ -1176,6 +1261,52 @@
|
|||
} ],
|
||||
"documentation" : "<p>Gets a collection of Tag resources.</p>"
|
||||
},
|
||||
"GetVpcLink" : {
|
||||
"name" : "GetVpcLink",
|
||||
"http" : {
|
||||
"method" : "GET",
|
||||
"requestUri" : "/v2/vpclinks/{vpcLinkId}",
|
||||
"responseCode" : 200
|
||||
},
|
||||
"input" : {
|
||||
"shape" : "GetVpcLinkRequest"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"GetVpcLinks" : {
|
||||
"name" : "GetVpcLinks",
|
||||
"http" : {
|
||||
"method" : "GET",
|
||||
"requestUri" : "/v2/vpclinks",
|
||||
"responseCode" : 200
|
||||
},
|
||||
"input" : {
|
||||
"shape" : "GetVpcLinksRequest"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"ImportApi" : {
|
||||
"name" : "ImportApi",
|
||||
"http" : {
|
||||
|
|
@ -1445,7 +1576,7 @@
|
|||
},
|
||||
"output" : {
|
||||
"shape" : "UpdateIntegrationResult",
|
||||
"documentation" : "\n <p>Success</p>\n "
|
||||
"documentation" : "<p>Success</p>"
|
||||
},
|
||||
"errors" : [ {
|
||||
"shape" : "NotFoundException",
|
||||
|
|
@ -1532,7 +1663,7 @@
|
|||
},
|
||||
"output" : {
|
||||
"shape" : "UpdateRouteResult",
|
||||
"documentation" : "\n <p>Success</p>\n "
|
||||
"documentation" : "<p>Success</p>"
|
||||
},
|
||||
"errors" : [ {
|
||||
"shape" : "NotFoundException",
|
||||
|
|
@ -1606,6 +1737,32 @@
|
|||
"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
|
||||
},
|
||||
"input" : {
|
||||
"shape" : "UpdateVpcLinkRequest"
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"shapes" : {
|
||||
|
|
@ -2543,12 +2700,12 @@
|
|||
"ConnectionId" : {
|
||||
"shape" : "StringWithLengthBetween1And1024",
|
||||
"locationName" : "connectionId",
|
||||
"documentation" : "<p>The connection ID.</p>"
|
||||
"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. Currently the only valid value is INTERNET, for connections through the public routable internet.</p>"
|
||||
"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",
|
||||
|
|
@ -2573,12 +2730,12 @@
|
|||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 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>"
|
||||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 proxy integration, this is the URI of the Lambda function.</p>"
|
||||
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
|
||||
},
|
||||
"PassthroughBehavior" : {
|
||||
"shape" : "PassthroughBehavior",
|
||||
|
|
@ -2588,7 +2745,7 @@
|
|||
"PayloadFormatVersion" : {
|
||||
"shape" : "StringWithLengthBetween1And64",
|
||||
"locationName" : "payloadFormatVersion",
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.</p>"
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>"
|
||||
},
|
||||
"RequestParameters" : {
|
||||
"shape" : "IntegrationParameters",
|
||||
|
|
@ -2609,6 +2766,11 @@
|
|||
"shape" : "IntegerWithLengthBetween50And29000",
|
||||
"locationName" : "timeoutInMillis",
|
||||
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
|
||||
},
|
||||
"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>",
|
||||
|
|
@ -2626,12 +2788,12 @@
|
|||
"ConnectionId" : {
|
||||
"shape" : "StringWithLengthBetween1And1024",
|
||||
"locationName" : "connectionId",
|
||||
"documentation" : "<p>The connection ID.</p>"
|
||||
"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. Currently the only valid value is INTERNET, for connections through the public routable internet.</p>"
|
||||
"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",
|
||||
|
|
@ -2656,12 +2818,12 @@
|
|||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 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>"
|
||||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 proxy integration, this is the URI of the Lambda function.</p>"
|
||||
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
|
||||
},
|
||||
"PassthroughBehavior" : {
|
||||
"shape" : "PassthroughBehavior",
|
||||
|
|
@ -2671,7 +2833,7 @@
|
|||
"PayloadFormatVersion" : {
|
||||
"shape" : "StringWithLengthBetween1And64",
|
||||
"locationName" : "payloadFormatVersion",
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.</p>"
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>"
|
||||
},
|
||||
"RequestParameters" : {
|
||||
"shape" : "IntegrationParameters",
|
||||
|
|
@ -2692,6 +2854,11 @@
|
|||
"shape" : "IntegerWithLengthBetween50And29000",
|
||||
"locationName" : "timeoutInMillis",
|
||||
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
|
||||
},
|
||||
"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>",
|
||||
|
|
@ -2708,12 +2875,12 @@
|
|||
"ConnectionId" : {
|
||||
"shape" : "StringWithLengthBetween1And1024",
|
||||
"locationName" : "connectionId",
|
||||
"documentation" : "<p>The connection ID.</p>"
|
||||
"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. Currently the only valid value is INTERNET, for connections through the public routable internet.</p>"
|
||||
"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",
|
||||
|
|
@ -2748,12 +2915,12 @@
|
|||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 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>"
|
||||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 proxy integration, this is the URI of the Lambda function.</p>"
|
||||
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
|
||||
},
|
||||
"PassthroughBehavior" : {
|
||||
"shape" : "PassthroughBehavior",
|
||||
|
|
@ -2763,7 +2930,7 @@
|
|||
"PayloadFormatVersion" : {
|
||||
"shape" : "StringWithLengthBetween1And64",
|
||||
"locationName" : "payloadFormatVersion",
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.</p>"
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>"
|
||||
},
|
||||
"RequestParameters" : {
|
||||
"shape" : "IntegrationParameters",
|
||||
|
|
@ -2784,6 +2951,11 @@
|
|||
"shape" : "IntegerWithLengthBetween50And29000",
|
||||
"locationName" : "timeoutInMillis",
|
||||
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3330,7 +3502,7 @@
|
|||
"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-._~:/?#&=,]+. Supported only for WebSocket APIs.</p>"
|
||||
"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",
|
||||
|
|
@ -3393,7 +3565,7 @@
|
|||
"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-._~:/?#&=,]+. Supported only for WebSocket APIs.</p>"
|
||||
"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",
|
||||
|
|
@ -3470,7 +3642,7 @@
|
|||
"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-._~:/?#&=,]+. Supported only for WebSocket APIs.</p>"
|
||||
"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",
|
||||
|
|
@ -3479,6 +3651,128 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"Tags" : {
|
||||
"shape" : "Tags",
|
||||
"locationName" : "tags",
|
||||
"documentation" : "<p>A list of tags.</p>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"required" : [ "StageName", "ApiId" ]
|
||||
},
|
||||
"DeleteApiMappingRequest" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
|
|
@ -3647,6 +3941,30 @@
|
|||
},
|
||||
"required" : [ "ApiId", "RouteId" ]
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"RouteId" : {
|
||||
"shape" : "__string",
|
||||
"location" : "uri",
|
||||
"locationName" : "routeId",
|
||||
"documentation" : "<p>The route ID.</p>"
|
||||
}
|
||||
},
|
||||
"required" : [ "RequestParameterKey", "ApiId", "RouteId" ]
|
||||
},
|
||||
"DeleteRouteResponseRequest" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
|
|
@ -3713,6 +4031,22 @@
|
|||
},
|
||||
"required" : [ "StageName", "ApiId" ]
|
||||
},
|
||||
"DeleteVpcLinkRequest" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
"VpcLinkId" : {
|
||||
"shape" : "__string",
|
||||
"location" : "uri",
|
||||
"locationName" : "vpcLinkId",
|
||||
"documentation" : "<p>The ID of the VPC link.</p>"
|
||||
}
|
||||
},
|
||||
"required" : [ "VpcLinkId" ]
|
||||
},
|
||||
"DeleteVpcLinkResponse" : {
|
||||
"type" : "structure",
|
||||
"members" : { }
|
||||
},
|
||||
"Deployment" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
|
|
@ -4379,12 +4713,12 @@
|
|||
"ConnectionId" : {
|
||||
"shape" : "StringWithLengthBetween1And1024",
|
||||
"locationName" : "connectionId",
|
||||
"documentation" : "<p>The connection ID.</p>"
|
||||
"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. Currently the only valid value is INTERNET, for connections through the public routable internet.</p>"
|
||||
"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",
|
||||
|
|
@ -4419,12 +4753,12 @@
|
|||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 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>"
|
||||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 proxy integration, this is the URI of the Lambda function.</p>"
|
||||
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
|
||||
},
|
||||
"PassthroughBehavior" : {
|
||||
"shape" : "PassthroughBehavior",
|
||||
|
|
@ -4434,7 +4768,7 @@
|
|||
"PayloadFormatVersion" : {
|
||||
"shape" : "StringWithLengthBetween1And64",
|
||||
"locationName" : "payloadFormatVersion",
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.</p>"
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>"
|
||||
},
|
||||
"RequestParameters" : {
|
||||
"shape" : "IntegrationParameters",
|
||||
|
|
@ -4455,6 +4789,11 @@
|
|||
"shape" : "IntegerWithLengthBetween50And29000",
|
||||
"locationName" : "timeoutInMillis",
|
||||
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -5026,7 +5365,7 @@
|
|||
"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-._~:/?#&=,]+. Supported only for WebSocket APIs.</p>"
|
||||
"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",
|
||||
|
|
@ -5093,8 +5432,101 @@
|
|||
"shape" : "Tags",
|
||||
"locationName": "tags"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetVpcLinkRequest" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
"VpcLinkId" : {
|
||||
"shape" : "__string",
|
||||
"location" : "uri",
|
||||
"locationName" : "vpcLinkId",
|
||||
"documentation" : "<p>The ID of the VPC link.</p>"
|
||||
}
|
||||
},
|
||||
"required" : [ "Tags" ]
|
||||
"required" : [ "VpcLinkId" ]
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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",
|
||||
|
|
@ -5126,7 +5558,7 @@
|
|||
"shape" : "__string",
|
||||
"location" : "querystring",
|
||||
"locationName" : "basepath",
|
||||
"documentation" : "<p>Represents the base path of the imported API. Supported only for HTTP APIs.</p>"
|
||||
"documentation" : "<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>"
|
||||
},
|
||||
"Body" : {
|
||||
"shape" : "__string",
|
||||
|
|
@ -5220,19 +5652,19 @@
|
|||
},
|
||||
"IntegerWithLengthBetween0And3600" : {
|
||||
"type" : "integer",
|
||||
"documentation" : "\n <p>An integer with a value between [0-3600].</p>\n ",
|
||||
"documentation" : "<p>An integer with a value between [0-3600].</p>",
|
||||
"min" : 0,
|
||||
"max" : 3600
|
||||
},
|
||||
"IntegerWithLengthBetween50And29000" : {
|
||||
"type" : "integer",
|
||||
"documentation" : "\n <p>An integer with a value between [50-29000].</p>\n ",
|
||||
"documentation" : "<p>An integer with a value between [50-29000].</p>",
|
||||
"min" : 50,
|
||||
"max" : 29000
|
||||
},
|
||||
"IntegerWithLengthBetweenMinus1And86400" : {
|
||||
"type" : "integer",
|
||||
"documentation" : "\n <p>An integer with a value between [-1-86400].</p>\n ",
|
||||
"documentation" : "<p>An integer with a value between -1 and 86400. Supported only for HTTP APIs.</p>",
|
||||
"min" : -1,
|
||||
"max" : 86400
|
||||
},
|
||||
|
|
@ -5247,12 +5679,12 @@
|
|||
"ConnectionId" : {
|
||||
"shape" : "StringWithLengthBetween1And1024",
|
||||
"locationName" : "connectionId",
|
||||
"documentation" : "<p>The connection ID.</p>"
|
||||
"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. Currently the only valid value is INTERNET, for connections through the public routable internet.</p>"
|
||||
"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",
|
||||
|
|
@ -5287,12 +5719,12 @@
|
|||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 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>"
|
||||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 proxy integration, this is the URI of the Lambda function.</p>"
|
||||
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
|
||||
},
|
||||
"PassthroughBehavior" : {
|
||||
"shape" : "PassthroughBehavior",
|
||||
|
|
@ -5302,7 +5734,7 @@
|
|||
"PayloadFormatVersion" : {
|
||||
"shape" : "StringWithLengthBetween1And64",
|
||||
"locationName" : "payloadFormatVersion",
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.</p>"
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>"
|
||||
},
|
||||
"RequestParameters" : {
|
||||
"shape" : "IntegrationParameters",
|
||||
|
|
@ -5323,6 +5755,11 @@
|
|||
"shape" : "IntegerWithLengthBetween50And29000",
|
||||
"locationName" : "timeoutInMillis",
|
||||
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
|
||||
},
|
||||
"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>"
|
||||
|
|
@ -5446,7 +5883,7 @@
|
|||
"LoggingLevel" : {
|
||||
"type" : "string",
|
||||
"documentation" : "<p>The logging level.</p>",
|
||||
"enum" : [ "ERROR", "INFO", "false" ]
|
||||
"enum" : [ "ERROR", "INFO", "OFF" ]
|
||||
},
|
||||
"Model" : {
|
||||
"type" : "structure",
|
||||
|
|
@ -5566,7 +6003,7 @@
|
|||
"shape" : "__string",
|
||||
"location" : "querystring",
|
||||
"locationName" : "basepath",
|
||||
"documentation" : "<p>Represents the base path of the imported API. Supported only for HTTP APIs.</p>"
|
||||
"documentation" : "<p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html\">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>"
|
||||
},
|
||||
"Body" : {
|
||||
"shape" : "__string",
|
||||
|
|
@ -5819,12 +6256,12 @@
|
|||
"ThrottlingBurstLimit" : {
|
||||
"shape" : "__integer",
|
||||
"locationName" : "throttlingBurstLimit",
|
||||
"documentation" : "<p>Specifies the throttling burst limit. Supported only for WebSocket APIs.</p>"
|
||||
"documentation" : "<p>Specifies the throttling burst limit.</p>"
|
||||
},
|
||||
"ThrottlingRateLimit" : {
|
||||
"shape" : "__double",
|
||||
"locationName" : "throttlingRateLimit",
|
||||
"documentation" : "<p>Specifies the throttling rate limit. Supported only for WebSocket APIs.</p>"
|
||||
"documentation" : "<p>Specifies the throttling rate limit.</p>"
|
||||
}
|
||||
},
|
||||
"documentation" : "<p>Represents a collection of route settings.</p>"
|
||||
|
|
@ -5855,6 +6292,13 @@
|
|||
},
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"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>",
|
||||
|
|
@ -5934,7 +6378,7 @@
|
|||
"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-._~:/?#&=,]+. Supported only for WebSocket APIs.</p>"
|
||||
"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",
|
||||
|
|
@ -6007,6 +6451,13 @@
|
|||
"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"
|
||||
}
|
||||
},
|
||||
"TagResourceInput" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
|
|
@ -6071,6 +6522,28 @@
|
|||
"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>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"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" : {
|
||||
|
|
@ -6104,7 +6577,7 @@
|
|||
"shape" : "__listOf__string",
|
||||
"location" : "querystring",
|
||||
"locationName" : "tagKeys",
|
||||
"documentation" : "\n <p>The Tag keys to delete.</p>\n "
|
||||
"documentation" : "<p>The Tag keys to delete</p>"
|
||||
}
|
||||
},
|
||||
"required" : [ "ResourceArn", "TagKeys" ]
|
||||
|
|
@ -6668,12 +7141,12 @@
|
|||
"ConnectionId" : {
|
||||
"shape" : "StringWithLengthBetween1And1024",
|
||||
"locationName" : "connectionId",
|
||||
"documentation" : "<p>The connection ID.</p>"
|
||||
"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. Currently the only valid value is INTERNET, for connections through the public routable internet.</p>"
|
||||
"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",
|
||||
|
|
@ -6698,12 +7171,12 @@
|
|||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 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>"
|
||||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 proxy integration, this is the URI of the Lambda function.</p>"
|
||||
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
|
||||
},
|
||||
"PassthroughBehavior" : {
|
||||
"shape" : "PassthroughBehavior",
|
||||
|
|
@ -6713,7 +7186,7 @@
|
|||
"PayloadFormatVersion" : {
|
||||
"shape" : "StringWithLengthBetween1And64",
|
||||
"locationName" : "payloadFormatVersion",
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.</p>"
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>"
|
||||
},
|
||||
"RequestParameters" : {
|
||||
"shape" : "IntegrationParameters",
|
||||
|
|
@ -6734,6 +7207,11 @@
|
|||
"shape" : "IntegerWithLengthBetween50And29000",
|
||||
"locationName" : "timeoutInMillis",
|
||||
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
|
||||
},
|
||||
"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>"
|
||||
|
|
@ -6750,12 +7228,12 @@
|
|||
"ConnectionId" : {
|
||||
"shape" : "StringWithLengthBetween1And1024",
|
||||
"locationName" : "connectionId",
|
||||
"documentation" : "<p>The connection ID.</p>"
|
||||
"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. Currently the only valid value is INTERNET, for connections through the public routable internet.</p>"
|
||||
"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",
|
||||
|
|
@ -6786,12 +7264,12 @@
|
|||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 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>"
|
||||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 proxy integration, this is the URI of the Lambda function.</p>"
|
||||
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
|
||||
},
|
||||
"PassthroughBehavior" : {
|
||||
"shape" : "PassthroughBehavior",
|
||||
|
|
@ -6801,7 +7279,7 @@
|
|||
"PayloadFormatVersion" : {
|
||||
"shape" : "StringWithLengthBetween1And64",
|
||||
"locationName" : "payloadFormatVersion",
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.</p>"
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>"
|
||||
},
|
||||
"RequestParameters" : {
|
||||
"shape" : "IntegrationParameters",
|
||||
|
|
@ -6822,6 +7300,11 @@
|
|||
"shape" : "IntegerWithLengthBetween50And29000",
|
||||
"locationName" : "timeoutInMillis",
|
||||
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
|
||||
},
|
||||
"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>",
|
||||
|
|
@ -6838,12 +7321,12 @@
|
|||
"ConnectionId" : {
|
||||
"shape" : "StringWithLengthBetween1And1024",
|
||||
"locationName" : "connectionId",
|
||||
"documentation" : "<p>The connection ID.</p>"
|
||||
"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. Currently the only valid value is INTERNET, for connections through the public routable internet.</p>"
|
||||
"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",
|
||||
|
|
@ -6878,12 +7361,12 @@
|
|||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 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>"
|
||||
"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 the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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 proxy integration, this is the URI of the Lambda function.</p>"
|
||||
"documentation" : "<p>For a Lambda integration, specify the URI of a Lambda function.</p> <p>For an HTTP integration, specify a fully-qualified URL.</p> <p>For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see <a href=\"https://alpha-docs-aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html\">DiscoverInstances</a>. For private integrations, all resources must be owned by the same AWS account.</p>"
|
||||
},
|
||||
"PassthroughBehavior" : {
|
||||
"shape" : "PassthroughBehavior",
|
||||
|
|
@ -6893,7 +7376,7 @@
|
|||
"PayloadFormatVersion" : {
|
||||
"shape" : "StringWithLengthBetween1And64",
|
||||
"locationName" : "payloadFormatVersion",
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.</p>"
|
||||
"documentation" : "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>"
|
||||
},
|
||||
"RequestParameters" : {
|
||||
"shape" : "IntegrationParameters",
|
||||
|
|
@ -6914,6 +7397,11 @@
|
|||
"shape" : "IntegerWithLengthBetween50And29000",
|
||||
"locationName" : "timeoutInMillis",
|
||||
"documentation" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.</p>"
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -7475,7 +7963,7 @@
|
|||
"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-._~:/?#&=,]+. Supported only for WebSocket APIs.</p>"
|
||||
"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>"
|
||||
|
|
@ -7533,7 +8021,7 @@
|
|||
"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-._~:/?#&=,]+. Supported only for WebSocket APIs.</p>"
|
||||
"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>",
|
||||
|
|
@ -7605,7 +8093,7 @@
|
|||
"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-._~:/?#&=,]+. Supported only for WebSocket APIs.</p>"
|
||||
"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",
|
||||
|
|
@ -7614,10 +8102,167 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"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" ]
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"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>"
|
||||
},
|
||||
"__boolean" : {
|
||||
"type" : "boolean"
|
||||
},
|
||||
|
|
@ -7693,6 +8338,12 @@
|
|||
"shape" : "Stage"
|
||||
}
|
||||
},
|
||||
"__listOfVpcLink" : {
|
||||
"type" : "list",
|
||||
"member" : {
|
||||
"shape" : "VpcLink"
|
||||
}
|
||||
},
|
||||
"__listOf__string" : {
|
||||
"type" : "list",
|
||||
"member" : {
|
||||
|
|
@ -7714,15 +8365,5 @@
|
|||
"timestampFormat" : "unixTimestamp"
|
||||
}
|
||||
},
|
||||
"authorizers" : {
|
||||
"authorization_strategy" : {
|
||||
"name" : "authorization_strategy",
|
||||
"type" : "provided",
|
||||
"placement" : {
|
||||
"location" : "header",
|
||||
"name" : "Authorization"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation" : "<p>Amazon API Gateway V2</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalServerException"}
|
||||
],
|
||||
"documentation":"<p>Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents and SSM Parameter Store parameters. A configuration profile includes the following information.</p> <ul> <li> <p>The Uri location of the configuration data.</p> </li> <li> <p>The AWS Identity and Access Management (IAM) role that provides access to the configuration data.</p> </li> <li> <p>A validator for the configuration data. Available validators include either a JSON Schema or an AWS Lambda function.</p> </li> </ul>"
|
||||
"documentation":"<p>Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 objects. A configuration profile includes the following information.</p> <ul> <li> <p>The Uri location of the configuration data.</p> </li> <li> <p>The AWS Identity and Access Management (IAM) role that provides access to the configuration data.</p> </li> <li> <p>A validator for the configuration data. Available validators include either a JSON Schema or an AWS Lambda function.</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-creating-configuration-and-profile.html\">Create a Configuration and a Configuration Profile</a> in the <i>AWS AppConfig User Guide</i>.</p>"
|
||||
},
|
||||
"CreateDeploymentStrategy":{
|
||||
"name":"CreateDeploymentStrategy",
|
||||
|
|
@ -672,7 +672,7 @@
|
|||
},
|
||||
"LocationUri":{
|
||||
"shape":"Uri",
|
||||
"documentation":"<p>A URI to locate the configuration. You can specify either a Systems Manager (SSM) document or an SSM Parameter Store parameter. For an SSM document, specify either the document name in the format <code>ssm-document://<Document name></code> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format <code>ssm-parameter://<Parameter name></code> or the ARN.</p>"
|
||||
"documentation":"<p>A URI to locate the configuration. You can specify a Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For an SSM document, specify either the document name in the format <code>ssm-document://<Document_name></code> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format <code>ssm-parameter://<Parameter_name></code> or the ARN. For an Amazon S3 object, specify the URI in the following format: <code>s3://<bucket>/<objectKey> </code>. Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json</p>"
|
||||
},
|
||||
"RetrievalRoleArn":{
|
||||
"shape":"Arn",
|
||||
|
|
@ -721,7 +721,7 @@
|
|||
},
|
||||
"GrowthType":{
|
||||
"shape":"GrowthType",
|
||||
"documentation":"<p>The algorithm used to define how percentage grows over time.</p>"
|
||||
"documentation":"<p>The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:</p> <p> <b>Linear</b>: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for <code>Step percentage</code>. For example, a linear deployment that uses a <code>Step percentage</code> of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.</p> <p> <b>Exponential</b>: For this type, AppConfig processes the deployment exponentially using the following formula: <code>G*(2^N)</code>. In this formula, <code>G</code> is the growth factor specified by the user and <code>N</code> is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:</p> <p> <code>2*(2^0)</code> </p> <p> <code>2*(2^1)</code> </p> <p> <code>2*(2^2)</code> </p> <p>Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.</p>"
|
||||
},
|
||||
"ReplicateTo":{
|
||||
"shape":"ReplicateTo",
|
||||
|
|
@ -1143,19 +1143,19 @@
|
|||
"members":{
|
||||
"Application":{
|
||||
"shape":"StringWithLengthBetween1And64",
|
||||
"documentation":"<p>The application to get.</p>",
|
||||
"documentation":"<p>The application to get. Specify either the application name or the application ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Application"
|
||||
},
|
||||
"Environment":{
|
||||
"shape":"StringWithLengthBetween1And64",
|
||||
"documentation":"<p>The environment to get.</p>",
|
||||
"documentation":"<p>The environment to get. Specify either the environment name or the environment ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Environment"
|
||||
},
|
||||
"Configuration":{
|
||||
"shape":"StringWithLengthBetween1And64",
|
||||
"documentation":"<p>The configuration to get.</p>",
|
||||
"documentation":"<p>The configuration to get. Specify either the configuration name or the configuration ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Configuration"
|
||||
},
|
||||
|
|
@ -1242,7 +1242,10 @@
|
|||
},
|
||||
"GrowthType":{
|
||||
"type":"string",
|
||||
"enum":["LINEAR"]
|
||||
"enum":[
|
||||
"LINEAR",
|
||||
"EXPONENTIAL"
|
||||
]
|
||||
},
|
||||
"Id":{
|
||||
"type":"string",
|
||||
|
|
@ -1700,7 +1703,7 @@
|
|||
},
|
||||
"GrowthType":{
|
||||
"shape":"GrowthType",
|
||||
"documentation":"<p>The algorithm used to define how percentage grows over time.</p>"
|
||||
"documentation":"<p>The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:</p> <p> <b>Linear</b>: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.</p> <p> <b>Exponential</b>: For this type, AppConfig processes the deployment exponentially using the following formula: <code>G*(2^N)</code>. In this formula, <code>G</code> is the growth factor specified by the user and <code>N</code> is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:</p> <p> <code>2*(2^0)</code> </p> <p> <code>2*(2^1)</code> </p> <p> <code>2*(2^2)</code> </p> <p>Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1783,7 +1786,7 @@
|
|||
},
|
||||
"Content":{
|
||||
"shape":"StringWithLengthBetween0And32768",
|
||||
"documentation":"<p>Either the JSON Schema content or an AWS Lambda function name.</p>"
|
||||
"documentation":"<p>Either the JSON Schema content or the Amazon Resource Name (ARN) of an AWS Lambda function.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.</p>"
|
||||
|
|
|
|||
|
|
@ -94,7 +94,7 @@
|
|||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Creates a route that is associated with a virtual router.</p>\n <p>You can use the <code>prefix</code> parameter in your route specification for path-based\n routing of requests. For example, if your virtual service name is\n <code>my-service.local</code> and you want the route to match requests to\n <code>my-service.local/metrics</code>, your prefix should be\n <code>/metrics</code>.</p>\n <p>If your route matches a request, you can distribute traffic to one or more target\n virtual nodes with relative weighting.</p>",
|
||||
"documentation": "<p>Creates a route that is associated with a virtual router.</p>\n <p>You can use the <code>prefix</code> parameter in your route specification for path-based\n routing of requests. For example, if your virtual service name is\n <code>my-service.local</code> and you want the route to match requests to\n <code>my-service.local/metrics</code>, your prefix should be\n <code>/metrics</code>.</p>\n <p>If your route matches a request, you can distribute traffic to one or more target\n virtual nodes with relative weighting.</p>\n <p>For more information about routes, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html\">Routes</a>.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"CreateVirtualNode": {
|
||||
|
|
@ -136,7 +136,7 @@
|
|||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Creates a virtual node within a service mesh.</p>\n <p>A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS\n service or a Kubernetes deployment. When you create a virtual node, you can specify the\n service discovery information for your task group.</p>\n <p>Any inbound traffic that your virtual node expects should be specified as a\n <code>listener</code>. Any outbound traffic that your virtual node expects to reach\n should be specified as a <code>backend</code>.</p>\n <p>The response metadata for your new virtual node contains the <code>arn</code> that is\n associated with the virtual node. Set this value (either the full ARN or the truncated\n resource name: for example, <code>mesh/default/virtualNode/simpleapp</code>) as the\n <code>APPMESH_VIRTUAL_NODE_NAME</code> environment variable for your task group's Envoy\n proxy container in your task definition or pod spec. This is then mapped to the\n <code>node.id</code> and <code>node.cluster</code> Envoy parameters.</p>\n <note>\n <p>If you require your Envoy stats or tracing to use a different name, you can override\n the <code>node.cluster</code> value that is set by\n <code>APPMESH_VIRTUAL_NODE_NAME</code> with the\n <code>APPMESH_VIRTUAL_NODE_CLUSTER</code> environment variable.</p>\n </note>",
|
||||
"documentation": "<p>Creates a virtual node within a service mesh.</p>\n <p>A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS\n service or a Kubernetes deployment. When you create a virtual node, you can specify the\n service discovery information for your task group.</p>\n <p>Any inbound traffic that your virtual node expects should be specified as a\n <code>listener</code>. Any outbound traffic that your virtual node expects to reach\n should be specified as a <code>backend</code>.</p>\n <p>The response metadata for your new virtual node contains the <code>arn</code> that is\n associated with the virtual node. Set this value (either the full ARN or the truncated\n resource name: for example, <code>mesh/default/virtualNode/simpleapp</code>) as the\n <code>APPMESH_VIRTUAL_NODE_NAME</code> environment variable for your task group's Envoy\n proxy container in your task definition or pod spec. This is then mapped to the\n <code>node.id</code> and <code>node.cluster</code> Envoy parameters.</p>\n <note>\n <p>If you require your Envoy stats or tracing to use a different name, you can override\n the <code>node.cluster</code> value that is set by\n <code>APPMESH_VIRTUAL_NODE_NAME</code> with the\n <code>APPMESH_VIRTUAL_NODE_CLUSTER</code> environment variable.</p>\n </note>\n <p>For more information about virtual nodes, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html\">Virtual Nodes</a>.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"CreateVirtualRouter": {
|
||||
|
|
@ -178,7 +178,7 @@
|
|||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Creates a virtual router within a service mesh.</p>\n <p>Any inbound traffic that your virtual router expects should be specified as a\n <code>listener</code>. </p>\n <p>Virtual routers handle traffic for one or more virtual services within your mesh. After\n you create your virtual router, create and associate routes for your virtual router that\n direct incoming requests to different virtual nodes.</p>",
|
||||
"documentation": "<p>Creates a virtual router within a service mesh.</p>\n <p>Any inbound traffic that your virtual router expects should be specified as a\n <code>listener</code>. </p>\n <p>Virtual routers handle traffic for one or more virtual services within your mesh. After\n you create your virtual router, create and associate routes for your virtual router that\n direct incoming requests to different virtual nodes.</p>\n <p>For more information about virtual routers, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html\">Virtual Routers</a>.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"CreateVirtualService": {
|
||||
|
|
@ -220,7 +220,7 @@
|
|||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Creates a virtual service within a service mesh.</p>\n <p>A virtual service is an abstraction of a real service that is provided by a virtual node\n directly or indirectly by means of a virtual router. Dependent services call your virtual\n service by its <code>virtualServiceName</code>, and those requests are routed to the\n virtual node or virtual router that is specified as the provider for the virtual\n service.</p>",
|
||||
"documentation": "<p>Creates a virtual service within a service mesh.</p>\n <p>A virtual service is an abstraction of a real service that is provided by a virtual node\n directly or indirectly by means of a virtual router. Dependent services call your virtual\n service by its <code>virtualServiceName</code>, and those requests are routed to the\n virtual node or virtual router that is specified as the provider for the virtual\n service.</p>\n <p>For more information about virtual services, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html\">Virtual Services</a>.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"DeleteMesh": {
|
||||
|
|
@ -1096,95 +1096,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a virtual router listener.</p>"
|
||||
},
|
||||
"UpdateVirtualNodeInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualNodeName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual node resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualNodeSpec",
|
||||
"documentation": "<p>The new virtual node specification to apply. This overwrites the existing data.</p>"
|
||||
},
|
||||
"virtualNodeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual node to update.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualNodeName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"DeleteMeshInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to delete.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"TcpRetryPolicyEvents": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "TcpRetryPolicyEvent"
|
||||
},
|
||||
"min": 1,
|
||||
"max": 1
|
||||
},
|
||||
"CreateVirtualServiceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to create the virtual service in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualServiceSpec",
|
||||
"documentation": "<p>The virtual service specification to apply.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "TagList",
|
||||
"documentation": "<p>Optional metadata that you can apply to the virtual service to assist with\n categorization and organization. Each tag consists of a key and an optional value, both of\n which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name to use for the virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"VirtualRouterStatusCode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
|
|
@ -1193,38 +1104,6 @@
|
|||
"INACTIVE"
|
||||
]
|
||||
},
|
||||
"UpdateVirtualRouterInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual router resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualRouterSpec",
|
||||
"documentation": "<p>The new virtual router specification to apply. This overwrites the existing data.</p>"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router to update.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"TagKeyList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
@ -1263,33 +1142,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a retry policy. Specify at least one value for at least one of the types of <code>RetryEvents</code>, a value for <code>maxRetries</code>, and a value for <code>perRetryTimeout</code>.</p>"
|
||||
},
|
||||
"ListTagsForResourceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"resourceArn"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "TagsLimit",
|
||||
"documentation": "<p>The maximum number of tag results returned by <code>ListTagsForResource</code> in\n paginated output. When this parameter is used, <code>ListTagsForResource</code> returns\n only <code>limit</code> results in a single page along with a <code>nextToken</code>\n response element. You can see the remaining results of the initial request by sending\n another <code>ListTagsForResource</code> request with the returned <code>nextToken</code>\n value. This value can be between 1 and 100. If you don't use\n this parameter, <code>ListTagsForResource</code> returns up to 100\n results and a <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListTagsForResource</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
},
|
||||
"resourceArn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) that identifies the resource to list the tags for.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "resourceArn"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"CreateVirtualNodeOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1314,29 +1166,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the logging information for a virtual node.</p>"
|
||||
},
|
||||
"GrpcRetryPolicyEvents": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "GrpcRetryPolicyEvent"
|
||||
},
|
||||
"min": 1,
|
||||
"max": 5
|
||||
},
|
||||
"ServiceUnavailableException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape": "String"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>The request has failed due to a temporary failure of the service.</p>",
|
||||
"exception": true,
|
||||
"error": {
|
||||
"code": "ServiceUnavailableException",
|
||||
"httpStatusCode": 503,
|
||||
"fault": true
|
||||
}
|
||||
},
|
||||
"Long": {
|
||||
"type": "long",
|
||||
"box": true
|
||||
|
|
@ -1355,42 +1184,6 @@
|
|||
"documentation": "",
|
||||
"payload": "virtualRouter"
|
||||
},
|
||||
"DescribeMeshOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"mesh"
|
||||
],
|
||||
"members": {
|
||||
"mesh": {
|
||||
"shape": "MeshData",
|
||||
"documentation": "<p>The full description of your service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "mesh"
|
||||
},
|
||||
"DeleteVirtualRouterInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to delete the virtual router in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router to delete.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"ListVirtualRoutersOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1408,55 +1201,14 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"DescribeRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"routeName",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the route resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"routeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the route to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "routeName"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router that the route is associated with.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"DeleteRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"route"
|
||||
],
|
||||
"members": {
|
||||
"route": {
|
||||
"shape": "RouteData",
|
||||
"documentation": "<p>The route that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "route"
|
||||
},
|
||||
"ResourceMetadata": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"createdAt",
|
||||
"lastUpdatedAt",
|
||||
"meshOwner",
|
||||
"resourceOwner",
|
||||
"uid",
|
||||
"version"
|
||||
],
|
||||
|
|
@ -1473,6 +1225,14 @@
|
|||
"shape": "Timestamp",
|
||||
"documentation": "<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"resourceOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner, or another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"uid": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The unique identifier for the resource.</p>"
|
||||
|
|
@ -1484,22 +1244,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents metadata for a resource.</p>"
|
||||
},
|
||||
"Listeners": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "Listener"
|
||||
},
|
||||
"min": 0,
|
||||
"max": 1
|
||||
},
|
||||
"Backends": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "Backend"
|
||||
},
|
||||
"min": 0,
|
||||
"max": 25
|
||||
},
|
||||
"ResourceInUseException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1515,15 +1259,6 @@
|
|||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"PortProtocol": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"grpc",
|
||||
"http",
|
||||
"http2",
|
||||
"tcp"
|
||||
]
|
||||
},
|
||||
"UpdateVirtualNodeOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1561,6 +1296,10 @@
|
|||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"clientPolicy": {
|
||||
"shape": "ClientPolicy",
|
||||
"documentation": "<p>A reference to an object that represents the client policy for a backend.</p>"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name of the virtual service that is acting as a virtual node backend.</p>"
|
||||
|
|
@ -1568,17 +1307,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a virtual service backend for a virtual node.</p>"
|
||||
},
|
||||
"VirtualNodeStatusCode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ACTIVE",
|
||||
"DELETED",
|
||||
"INACTIVE"
|
||||
]
|
||||
},
|
||||
"ServiceName": {
|
||||
"type": "string"
|
||||
},
|
||||
"BadRequestException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1594,62 +1322,6 @@
|
|||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"UpdateVirtualServiceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual service resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualServiceSpec",
|
||||
"documentation": "<p>The new virtual service specification to apply. This overwrites the existing\n data.</p>"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name of the virtual service to update.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualServiceName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"HealthCheckThreshold": {
|
||||
"type": "integer",
|
||||
"min": 2,
|
||||
"max": 10
|
||||
},
|
||||
"UpdateRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"route"
|
||||
],
|
||||
"members": {
|
||||
"route": {
|
||||
"shape": "RouteData",
|
||||
"documentation": "<p>A full description of the route that was updated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "route"
|
||||
},
|
||||
"PercentInt": {
|
||||
"type": "integer",
|
||||
"min": 0,
|
||||
"max": 100
|
||||
},
|
||||
"GrpcRouteMetadataList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
@ -1658,62 +1330,13 @@
|
|||
"min": 1,
|
||||
"max": 10
|
||||
},
|
||||
"MethodName": {
|
||||
"ListenerTlsMode": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
"max": 50
|
||||
},
|
||||
"TagValue": {
|
||||
"type": "string",
|
||||
"min": 0,
|
||||
"max": 256
|
||||
},
|
||||
"HttpRouteAction": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"weightedTargets"
|
||||
],
|
||||
"members": {
|
||||
"weightedTargets": {
|
||||
"shape": "WeightedTargets",
|
||||
"documentation": "<p>An object that represents the targets that traffic is routed to when a request matches the route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"ListRoutesInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "ListRoutesLimit",
|
||||
"documentation": "<p>The maximum number of results returned by <code>ListRoutes</code> in paginated output.\n When you use this parameter, <code>ListRoutes</code> returns only <code>limit</code>\n results in a single page along with a <code>nextToken</code> response element. You can see\n the remaining results of the initial request by sending another <code>ListRoutes</code>\n request with the returned <code>nextToken</code> value. This value can be between\n 1 and 100. If you don't use this parameter,\n <code>ListRoutes</code> returns up to 100 results and a\n <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to list routes in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListRoutes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router to list routes in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
"enum": [
|
||||
"DISABLED",
|
||||
"PERMISSIVE",
|
||||
"STRICT"
|
||||
]
|
||||
},
|
||||
"HealthCheckPolicy": {
|
||||
"type": "structure",
|
||||
|
|
@ -1735,7 +1358,7 @@
|
|||
},
|
||||
"path": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The destination path for the health check request. This is required only if the\n specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.</p>"
|
||||
"documentation": "<p>The destination path for the health check request. This value is only used if the specified \n protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.</p>"
|
||||
},
|
||||
"port": {
|
||||
"shape": "PortNumber",
|
||||
|
|
@ -1743,7 +1366,7 @@
|
|||
},
|
||||
"protocol": {
|
||||
"shape": "PortProtocol",
|
||||
"documentation": "<p>The protocol for the health check request.</p>"
|
||||
"documentation": "<p>The protocol for the health check request. If you specify <code>grpc</code>, then your service must conform to the <a href=\"https://github.com/grpc/grpc/blob/master/doc/health-checking.md\">GRPC Health Checking Protocol</a>.</p>"
|
||||
},
|
||||
"timeoutMillis": {
|
||||
"shape": "HealthCheckTimeoutMillis",
|
||||
|
|
@ -1756,29 +1379,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the health check policy for a virtual node's listener.</p>"
|
||||
},
|
||||
"VirtualServiceRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"meshName",
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"arn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The full Amazon Resource Name (ARN) for the virtual service.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual service resides in.</p>"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name of the virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual service returned by a list operation.</p>"
|
||||
},
|
||||
"EgressFilter": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1798,99 +1398,20 @@
|
|||
"shape": "VirtualServiceRef"
|
||||
}
|
||||
},
|
||||
"VirtualNodeStatus": {
|
||||
"ClientPolicy": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"status"
|
||||
],
|
||||
"members": {
|
||||
"status": {
|
||||
"shape": "VirtualNodeStatusCode",
|
||||
"documentation": "<p>The current status of the virtual node.</p>"
|
||||
"tls": {
|
||||
"shape": "ClientPolicyTls",
|
||||
"documentation": "<p>A reference to an object that represents a Transport Layer Security (TLS) client policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the current status of the virtual node.</p>"
|
||||
},
|
||||
"VirtualRouterRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"meshName",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"arn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The full Amazon Resource Name (ARN) for the virtual router.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual router resides in.</p>"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual router returned by a list operation.</p>"
|
||||
},
|
||||
"VirtualServiceData": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"metadata",
|
||||
"spec",
|
||||
"status",
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual service resides in.</p>"
|
||||
},
|
||||
"metadata": {
|
||||
"shape": "ResourceMetadata"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualServiceSpec",
|
||||
"documentation": "<p>The specifications of the virtual service.</p>"
|
||||
},
|
||||
"status": {
|
||||
"shape": "VirtualServiceStatus",
|
||||
"documentation": "<p>The current status of the virtual service.</p>"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name of the virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual service returned by a describe operation.</p>"
|
||||
"documentation": "<p>An object that represents a client policy.</p>"
|
||||
},
|
||||
"Boolean": {
|
||||
"type": "boolean",
|
||||
"box": true
|
||||
},
|
||||
"HttpRouteHeader": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"name"
|
||||
],
|
||||
"members": {
|
||||
"invert": {
|
||||
"shape": "Boolean",
|
||||
"documentation": "<p>Specify <code>True</code> to match anything except the match criteria. The default value is <code>False</code>.</p>"
|
||||
},
|
||||
"match": {
|
||||
"shape": "HeaderMatchMethod",
|
||||
"documentation": "<p>The <code>HeaderMatchMethod</code> object.</p>"
|
||||
},
|
||||
"name": {
|
||||
"shape": "HeaderName",
|
||||
"documentation": "<p>A name for the HTTP header in the client request that will be matched on.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the HTTP header in the request.</p>"
|
||||
},
|
||||
"HttpRetryPolicyEvent": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
|
|
@ -1910,78 +1431,13 @@
|
|||
"documentation": "",
|
||||
"payload": "virtualService"
|
||||
},
|
||||
"FilePath": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"AwsCloudMapInstanceAttributes": {
|
||||
"CertificateAuthorityArns": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "AwsCloudMapInstanceAttribute"
|
||||
}
|
||||
},
|
||||
"VirtualNodeRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"meshName",
|
||||
"virtualNodeName"
|
||||
],
|
||||
"members": {
|
||||
"arn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The full Amazon Resource Name (ARN) for the virtual node.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual node resides in.</p>"
|
||||
},
|
||||
"virtualNodeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual node.</p>"
|
||||
}
|
||||
"shape": "Arn"
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual node returned by a list operation.</p>"
|
||||
},
|
||||
"CreateMeshInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name to use for the service mesh.</p>"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "MeshSpec",
|
||||
"documentation": "<p>The service mesh specification to apply.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "TagList",
|
||||
"documentation": "<p>Optional metadata that you can apply to the service mesh to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"GrpcRouteAction": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"weightedTargets"
|
||||
],
|
||||
"members": {
|
||||
"weightedTargets": {
|
||||
"shape": "WeightedTargets",
|
||||
"documentation": "<p>An object that represents the targets that traffic is routed to when a request matches the route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
"min": 1,
|
||||
"max": 3
|
||||
},
|
||||
"DescribeVirtualNodeOutput": {
|
||||
"type": "structure",
|
||||
|
|
@ -2003,34 +1459,6 @@
|
|||
"max": 1024,
|
||||
"pattern": "((?=^.{1,127}$)^([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9])(.([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9]))*$)|(^.$)"
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape": "String"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>You have exceeded a service limit for your account. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/service_limits.html\">Service\n Limits</a> in the <i>AWS App Mesh User Guide</i>.</p>",
|
||||
"exception": true,
|
||||
"error": {
|
||||
"code": "LimitExceededException",
|
||||
"httpStatusCode": 400,
|
||||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"UpdateMeshOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"mesh"
|
||||
],
|
||||
"members": {
|
||||
"mesh": {
|
||||
"shape": "MeshData"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "mesh"
|
||||
},
|
||||
"CreateRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2045,32 +1473,6 @@
|
|||
"documentation": "",
|
||||
"payload": "route"
|
||||
},
|
||||
"GrpcRouteMetadataMatchMethod": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"exact": {
|
||||
"shape": "HeaderMatch",
|
||||
"documentation": "<p>The value sent by the client must match the specified value exactly.</p>"
|
||||
},
|
||||
"prefix": {
|
||||
"shape": "HeaderMatch",
|
||||
"documentation": "<p>The value sent by the client must begin with the specified characters.</p>"
|
||||
},
|
||||
"range": {
|
||||
"shape": "MatchRange",
|
||||
"documentation": "<p>An object that represents the range of values to match on.</p>"
|
||||
},
|
||||
"regex": {
|
||||
"shape": "HeaderMatch",
|
||||
"documentation": "<p>The value sent by the client must include the specified characters.</p>"
|
||||
},
|
||||
"suffix": {
|
||||
"shape": "HeaderMatch",
|
||||
"documentation": "<p>The value sent by the client must end with the specified characters.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the match method. Specify one of the match values.</p>"
|
||||
},
|
||||
"DnsServiceDiscovery": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2084,34 +1486,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the DNS service discovery information for your virtual\n node.</p>"
|
||||
},
|
||||
"DescribeVirtualServiceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual service resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name of the virtual service to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualServiceName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"ListVirtualServicesLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"DeleteRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2126,6 +1500,12 @@
|
|||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"routeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the route to delete.</p>",
|
||||
|
|
@ -2179,40 +1559,12 @@
|
|||
"members": { },
|
||||
"documentation": ""
|
||||
},
|
||||
"AwsCloudMapInstanceAttribute": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"key",
|
||||
"value"
|
||||
],
|
||||
"members": {
|
||||
"key": {
|
||||
"shape": "AwsCloudMapInstanceAttributeKey",
|
||||
"documentation": "<p>The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service\n instance that contains the specified key and value is returned.</p>"
|
||||
},
|
||||
"value": {
|
||||
"shape": "AwsCloudMapInstanceAttributeValue",
|
||||
"documentation": "<p>The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service\n instance that contains the specified key and value is returned.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the AWS Cloud Map attribute information for your virtual\n node.</p>"
|
||||
},
|
||||
"TcpRetryPolicyEvent": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"connection-error"
|
||||
]
|
||||
},
|
||||
"VirtualServiceSpec": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"provider": {
|
||||
"shape": "VirtualServiceProvider",
|
||||
"documentation": "<p>The App Mesh object that is acting as the provider for a virtual service. You can specify\n a single virtual node or virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the specification of a virtual service.</p>"
|
||||
},
|
||||
"Backend": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -2223,42 +1575,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the backends that a virtual node is expected to send outbound\n traffic to. </p>"
|
||||
},
|
||||
"MatchRange": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"end",
|
||||
"start"
|
||||
],
|
||||
"members": {
|
||||
"end": {
|
||||
"shape": "Long",
|
||||
"documentation": "<p>The end of the range.</p>"
|
||||
},
|
||||
"start": {
|
||||
"shape": "Long",
|
||||
"documentation": "<p>The start of the range.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.</p>"
|
||||
},
|
||||
"ListVirtualRoutersLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"HealthCheckIntervalMillis": {
|
||||
"type": "long",
|
||||
"box": true,
|
||||
"min": 5000,
|
||||
"max": 300000
|
||||
},
|
||||
"VirtualRouterList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "VirtualRouterRef"
|
||||
}
|
||||
},
|
||||
"ListMeshesInput": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -2277,55 +1593,6 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"Arn": {
|
||||
"type": "string"
|
||||
},
|
||||
"TcpRoute": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"action"
|
||||
],
|
||||
"members": {
|
||||
"action": {
|
||||
"shape": "TcpRouteAction",
|
||||
"documentation": "<p>The action to take if a match is determined.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a TCP route type.</p>"
|
||||
},
|
||||
"VirtualNodeList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "VirtualNodeRef"
|
||||
}
|
||||
},
|
||||
"ListVirtualRoutersInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "ListVirtualRoutersLimit",
|
||||
"documentation": "<p>The maximum number of results returned by <code>ListVirtualRouters</code> in paginated\n output. When you use this parameter, <code>ListVirtualRouters</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualRouters</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualRouters</code> returns up to 100 results and\n a <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to list virtual routers in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualRouters</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"VirtualRouterData": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2383,46 +1650,6 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"DurationUnit": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ms",
|
||||
"s"
|
||||
]
|
||||
},
|
||||
"RoutePriority": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 0,
|
||||
"max": 1000
|
||||
},
|
||||
"ListVirtualServicesInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "ListVirtualServicesLimit",
|
||||
"documentation": "<p>The maximum number of results returned by <code>ListVirtualServices</code> in paginated\n output. When you use this parameter, <code>ListVirtualServices</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualServices</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualServices</code> returns up to 100 results and\n a <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to list virtual services in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualServices</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"CreateVirtualRouterInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2442,13 +1669,22 @@
|
|||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualRouterSpec",
|
||||
"documentation": "<p>The virtual router specification to apply.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "TagList",
|
||||
"documentation": "<p>Optional metadata that you can apply to the virtual router to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
"documentation": "<p>Optional metadata that you can apply to the virtual router to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>",
|
||||
"tags": [
|
||||
"not-preview"
|
||||
]
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
|
|
@ -2457,43 +1693,6 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"AccessLog": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"file": {
|
||||
"shape": "FileAccessLog",
|
||||
"documentation": "<p>The file object to send virtual node access logs to.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the access logging information for a virtual node.</p>"
|
||||
},
|
||||
"ListVirtualNodesInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "ListVirtualNodesLimit",
|
||||
"documentation": "<p>The maximum number of results returned by <code>ListVirtualNodes</code> in paginated\n output. When you use this parameter, <code>ListVirtualNodes</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualNodes</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualNodes</code> returns up to 100 results and a\n <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to list virtual nodes in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualNodes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"DescribeVirtualRouterOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2557,17 +1756,19 @@
|
|||
"min": 1,
|
||||
"max": 25
|
||||
},
|
||||
"ListVirtualNodesLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"HealthCheckTimeoutMillis": {
|
||||
"type": "long",
|
||||
"box": true,
|
||||
"min": 2000,
|
||||
"max": 60000
|
||||
"ListenerTlsCertificate": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"acm": {
|
||||
"shape": "ListenerTlsAcmCertificate",
|
||||
"documentation": "<p>A reference to an object that represents an AWS Certicate Manager (ACM) certificate.</p>"
|
||||
},
|
||||
"file": {
|
||||
"shape": "ListenerTlsFileCertificate",
|
||||
"documentation": "<p>A reference to an object that represents a local file certificate.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a listener's Transport Layer Security (TLS) certificate.</p>"
|
||||
},
|
||||
"ListMeshesLimit": {
|
||||
"type": "integer",
|
||||
|
|
@ -2575,11 +1776,6 @@
|
|||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"ResourceName": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"AwsCloudMapInstanceAttributeKey": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
|
|
@ -2596,39 +1792,20 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the specification of a virtual router.</p>"
|
||||
},
|
||||
"TooManyRequestsException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape": "String"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>The maximum request rate permitted by the App Mesh APIs has been exceeded for your\n account. For best results, use an increasing or variable sleep interval between\n requests.</p>",
|
||||
"exception": true,
|
||||
"error": {
|
||||
"code": "TooManyRequestsException",
|
||||
"httpStatusCode": 429,
|
||||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"Timestamp": {
|
||||
"type": "timestamp"
|
||||
},
|
||||
"HeaderMatch": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"VirtualNodeSpec": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"backendDefaults": {
|
||||
"shape": "BackendDefaults",
|
||||
"documentation": "<p>A reference to an object that represents the defaults for backends.</p>"
|
||||
},
|
||||
"backends": {
|
||||
"shape": "Backends",
|
||||
"documentation": "<p>The backends that the virtual node is expected to send outbound traffic to.</p>"
|
||||
},
|
||||
"listeners": {
|
||||
"shape": "Listeners",
|
||||
"documentation": "<p>The listeners that the virtual node is expected to receive inbound traffic from.\n You can specify one listener.</p>"
|
||||
"documentation": "<p>The listener that the virtual node is expected to receive inbound traffic from.\n You can specify one listener.</p>"
|
||||
},
|
||||
"logging": {
|
||||
"shape": "Logging",
|
||||
|
|
@ -2636,7 +1813,7 @@
|
|||
},
|
||||
"serviceDiscovery": {
|
||||
"shape": "ServiceDiscovery",
|
||||
"documentation": "<p>The service discovery information for the virtual node. If your virtual node does not\n expect ingress traffic, you can omit this parameter.</p>"
|
||||
"documentation": "<p>The service discovery information for the virtual node. If your virtual node does not\n expect ingress traffic, you can omit this parameter. If you specify a <code>listener</code>,\n then you must specify service discovery information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the specification of a virtual node.</p>"
|
||||
|
|
@ -2666,6 +1843,12 @@
|
|||
"min": 1,
|
||||
"max": 1
|
||||
},
|
||||
"PortSet": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "PortNumber"
|
||||
}
|
||||
},
|
||||
"HttpMethod": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
|
|
@ -2680,20 +1863,6 @@
|
|||
"TRACE"
|
||||
]
|
||||
},
|
||||
"Duration": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"unit": {
|
||||
"shape": "DurationUnit",
|
||||
"documentation": "<p>A unit of time.</p>"
|
||||
},
|
||||
"value": {
|
||||
"shape": "DurationValue",
|
||||
"documentation": "<p>A number of time units.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a duration of time.</p>"
|
||||
},
|
||||
"ConflictException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -2709,98 +1878,30 @@
|
|||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"DescribeRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"route"
|
||||
],
|
||||
"members": {
|
||||
"route": {
|
||||
"shape": "RouteData",
|
||||
"documentation": "<p>The full description of your route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "route"
|
||||
},
|
||||
"HttpRouteMatch": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"prefix"
|
||||
],
|
||||
"members": {
|
||||
"headers": {
|
||||
"shape": "HttpRouteHeaders",
|
||||
"documentation": "<p>An object that represents the client request headers to match on.</p>"
|
||||
},
|
||||
"method": {
|
||||
"shape": "HttpMethod",
|
||||
"documentation": "<p>The client request method to match on. Specify only one.</p>"
|
||||
},
|
||||
"prefix": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Specifies the path to match requests with. This parameter must always start with\n <code>/</code>, which by itself matches all requests to the virtual service name. You\n can also match for path-based routing of requests. For example, if your virtual service\n name is <code>my-service.local</code> and you want the route to match requests to\n <code>my-service.local/metrics</code>, your prefix should be\n <code>/metrics</code>.</p>"
|
||||
},
|
||||
"scheme": {
|
||||
"shape": "HttpScheme",
|
||||
"documentation": "<p>The client request scheme to match on. Specify only one.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the requirements for a route to match HTTP requests for a virtual\n router.</p>"
|
||||
},
|
||||
"MeshList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "MeshRef"
|
||||
}
|
||||
},
|
||||
"TagRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"key"
|
||||
],
|
||||
"members": {
|
||||
"key": {
|
||||
"shape": "TagKey",
|
||||
"documentation": "<p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label\n that acts like a category for more specific tag values.</p>"
|
||||
},
|
||||
"value": {
|
||||
"shape": "TagValue",
|
||||
"documentation": "<p>The optional part of a key-value pair that make up a tag. A <code>value</code> acts as a\n descriptor within a tag category (key).</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Optional metadata that you apply to a resource to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
},
|
||||
"MeshRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"arn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The full Amazon Resource Name (ARN) of the service mesh.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a service mesh returned by a list operation.</p>"
|
||||
},
|
||||
"MaxRetries": {
|
||||
"type": "long",
|
||||
"box": true,
|
||||
"min": 0
|
||||
},
|
||||
"MeshStatusCode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ACTIVE",
|
||||
"DELETED",
|
||||
"INACTIVE"
|
||||
]
|
||||
"TlsValidationContextTrust": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"acm": {
|
||||
"shape": "TlsValidationContextAcmTrust",
|
||||
"documentation": "<p>A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.</p>"
|
||||
},
|
||||
"file": {
|
||||
"shape": "TlsValidationContextFileTrust",
|
||||
"documentation": "<p>An object that represents a TLS validation context trust for a local file.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) validation context trust.</p>"
|
||||
},
|
||||
"PortMapping": {
|
||||
"type": "structure",
|
||||
|
|
@ -2820,47 +1921,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a port mapping.</p>"
|
||||
},
|
||||
"MeshData": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"metadata",
|
||||
"spec",
|
||||
"status"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh.</p>"
|
||||
},
|
||||
"metadata": {
|
||||
"shape": "ResourceMetadata",
|
||||
"documentation": "<p>The associated metadata for the service mesh.</p>"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "MeshSpec",
|
||||
"documentation": "<p>The associated specification for the service mesh.</p>"
|
||||
},
|
||||
"status": {
|
||||
"shape": "MeshStatus",
|
||||
"documentation": "<p>The status of the service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a service mesh returned by a describe operation.</p>"
|
||||
},
|
||||
"VirtualRouterStatus": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"status"
|
||||
],
|
||||
"members": {
|
||||
"status": {
|
||||
"shape": "VirtualRouterStatusCode",
|
||||
"documentation": "<p>The current status of the virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the status of a virtual router. </p>"
|
||||
},
|
||||
"ListVirtualServicesOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2902,59 +1962,13 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a target and its relative weight. Traffic is distributed across\n targets according to their relative weight. For example, a weighted target with a relative\n weight of 50 receives five times as much traffic as one with a relative weight of\n 10. The total weight for all targets combined must be less than or equal to 100.</p>"
|
||||
},
|
||||
"TcpRouteAction": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"weightedTargets"
|
||||
],
|
||||
"members": {
|
||||
"weightedTargets": {
|
||||
"shape": "WeightedTargets",
|
||||
"documentation": "<p>An object that represents the targets that traffic is routed to when a request matches the route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"DescribeVirtualNodeInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualNodeName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual node resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"virtualNodeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual node to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualNodeName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"RouteStatus": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"status"
|
||||
],
|
||||
"members": {
|
||||
"status": {
|
||||
"shape": "RouteStatusCode",
|
||||
"documentation": "<p>The current status for the route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the current status of a route.</p>"
|
||||
},
|
||||
"RouteRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"meshName",
|
||||
"meshOwner",
|
||||
"resourceOwner",
|
||||
"routeName",
|
||||
"virtualRouterName"
|
||||
],
|
||||
|
|
@ -2967,6 +1981,14 @@
|
|||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the route resides in.</p>"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"resourceOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner, or another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"routeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the route.</p>"
|
||||
|
|
@ -2978,45 +2000,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a route returned by a list operation.</p>"
|
||||
},
|
||||
"Listener": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"portMapping"
|
||||
],
|
||||
"members": {
|
||||
"healthCheck": {
|
||||
"shape": "HealthCheckPolicy",
|
||||
"documentation": "<p>The health check information for the listener.</p>"
|
||||
},
|
||||
"portMapping": {
|
||||
"shape": "PortMapping",
|
||||
"documentation": "<p>The port mapping information for the listener.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a listener for a virtual node.</p>"
|
||||
},
|
||||
"GrpcRoute": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"action",
|
||||
"match"
|
||||
],
|
||||
"members": {
|
||||
"action": {
|
||||
"shape": "GrpcRouteAction",
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"match": {
|
||||
"shape": "GrpcRouteMatch",
|
||||
"documentation": "<p>An object that represents the criteria for determining a request match.</p>"
|
||||
},
|
||||
"retryPolicy": {
|
||||
"shape": "GrpcRetryPolicy",
|
||||
"documentation": "<p>An object that represents a retry policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a GRPC route type.</p>"
|
||||
},
|
||||
"DeleteVirtualNodeInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3030,6 +2013,12 @@
|
|||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"virtualNodeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual node to delete.</p>",
|
||||
|
|
@ -3085,39 +2074,6 @@
|
|||
"INACTIVE"
|
||||
]
|
||||
},
|
||||
"ListRoutesLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"DeleteVirtualServiceOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualService"
|
||||
],
|
||||
"members": {
|
||||
"virtualService": {
|
||||
"shape": "VirtualServiceData",
|
||||
"documentation": "<p>The virtual service that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "virtualService"
|
||||
},
|
||||
"VirtualNodeServiceProvider": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualNodeName"
|
||||
],
|
||||
"members": {
|
||||
"virtualNodeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual node that is acting as a service provider.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual node service provider.</p>"
|
||||
},
|
||||
"InternalServerErrorException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -3156,64 +2112,18 @@
|
|||
"unavailable"
|
||||
]
|
||||
},
|
||||
"HttpRetryPolicy": {
|
||||
"TlsValidationContextAcmTrust": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"maxRetries",
|
||||
"perRetryTimeout"
|
||||
"certificateAuthorityArns"
|
||||
],
|
||||
"members": {
|
||||
"httpRetryEvents": {
|
||||
"shape": "HttpRetryPolicyEvents",
|
||||
"documentation": "<p>Specify at least one of the following values.</p>\n <ul>\n <li>\n <p>\n <b>server-error</b> – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511</p>\n </li>\n <li>\n <p>\n <b>gateway-error</b> – HTTP status codes 502,\n 503, and 504</p>\n </li>\n <li>\n <p>\n <b>client-error</b> – HTTP status code 409</p>\n </li>\n <li>\n <p>\n <b>stream-error</b> – Retry on refused\n stream</p>\n </li>\n </ul>"
|
||||
},
|
||||
"maxRetries": {
|
||||
"shape": "MaxRetries",
|
||||
"documentation": "<p>The maximum number of retry attempts.</p>"
|
||||
},
|
||||
"perRetryTimeout": {
|
||||
"shape": "Duration",
|
||||
"documentation": "<p>An object that represents a duration of time.</p>"
|
||||
},
|
||||
"tcpRetryEvents": {
|
||||
"shape": "TcpRetryPolicyEvents",
|
||||
"documentation": "<p>Specify a valid value.</p>"
|
||||
"certificateAuthorityArns": {
|
||||
"shape": "CertificateAuthorityArns",
|
||||
"documentation": "<p>One or more ACM Amazon Resource Name (ARN)s.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a retry policy. Specify at least one value for at least one of the types of <code>RetryEvents</code>, a value for <code>maxRetries</code>, and a value for <code>perRetryTimeout</code>.</p>"
|
||||
},
|
||||
"DescribeVirtualRouterInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual router resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"TagResourceOutput": {
|
||||
"type": "structure",
|
||||
"members": { },
|
||||
"documentation": ""
|
||||
},
|
||||
"RouteList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "RouteRef"
|
||||
}
|
||||
"documentation": "<p>An object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.</p>"
|
||||
},
|
||||
"ForbiddenException": {
|
||||
"type": "structure",
|
||||
|
|
@ -3230,21 +2140,6 @@
|
|||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"TooManyTagsException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape": "String"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>The request exceeds the maximum allowed number of tags allowed per resource. The current\n limit is 50 user tags per resource. You must reduce the number of tags in the request. None\n of the tags in this request were applied.</p>",
|
||||
"exception": true,
|
||||
"error": {
|
||||
"code": "TooManyTagsException",
|
||||
"httpStatusCode": 400,
|
||||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"HeaderMatchMethod": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -3300,11 +2195,6 @@
|
|||
"Hostname": {
|
||||
"type": "string"
|
||||
},
|
||||
"PortNumber": {
|
||||
"type": "integer",
|
||||
"min": 1,
|
||||
"max": 65535
|
||||
},
|
||||
"TagResourceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3325,84 +2215,6 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"GrpcRouteMetadata": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"name"
|
||||
],
|
||||
"members": {
|
||||
"invert": {
|
||||
"shape": "Boolean",
|
||||
"documentation": "<p>Specify <code>True</code> to match anything except the match criteria. The default value is <code>False</code>.</p>"
|
||||
},
|
||||
"match": {
|
||||
"shape": "GrpcRouteMetadataMatchMethod",
|
||||
"documentation": "<p>An object that represents the data to match from the request.</p>"
|
||||
},
|
||||
"name": {
|
||||
"shape": "HeaderName",
|
||||
"documentation": "<p>The name of the route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the match metadata for the route.</p>"
|
||||
},
|
||||
"CreateRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"routeName",
|
||||
"spec",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to create the route in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"routeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name to use for the route.</p>"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "RouteSpec",
|
||||
"documentation": "<p>The route specification to apply.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "TagList",
|
||||
"documentation": "<p>Optional metadata that you can apply to the route to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router in which to create the route.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"WeightedTargets": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "WeightedTarget"
|
||||
},
|
||||
"min": 1,
|
||||
"max": 10
|
||||
},
|
||||
"HttpRouteHeaders": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "HttpRouteHeader"
|
||||
},
|
||||
"min": 1,
|
||||
"max": 10
|
||||
},
|
||||
"VirtualServiceProvider": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -3435,9 +2247,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the criteria for determining a request match.</p>"
|
||||
},
|
||||
"String": {
|
||||
"type": "string"
|
||||
},
|
||||
"AwsCloudMapServiceDiscovery": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3460,13 +2269,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the AWS Cloud Map service discovery information for your virtual\n node.</p>"
|
||||
},
|
||||
"HttpScheme": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"http",
|
||||
"https"
|
||||
]
|
||||
},
|
||||
"UpdateVirtualServiceOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3481,45 +2283,6 @@
|
|||
"documentation": "",
|
||||
"payload": "virtualService"
|
||||
},
|
||||
"UpdateRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"routeName",
|
||||
"spec",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the route resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"routeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the route to update.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "routeName"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "RouteSpec",
|
||||
"documentation": "<p>The new route specification to apply. This overwrites the existing data.</p>"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router that the route is associated with.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"MeshStatus": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -3549,13 +2312,22 @@
|
|||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualNodeSpec",
|
||||
"documentation": "<p>The virtual node specification to apply.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "TagList",
|
||||
"documentation": "<p>Optional metadata that you can apply to the virtual node to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
"documentation": "<p>Optional metadata that you can apply to the virtual node to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>",
|
||||
"tags": [
|
||||
"not-preview"
|
||||
]
|
||||
},
|
||||
"virtualNodeName": {
|
||||
"shape": "ResourceName",
|
||||
|
|
@ -3584,11 +2356,11 @@
|
|||
"members": {
|
||||
"grpcRoute": {
|
||||
"shape": "GrpcRoute",
|
||||
"documentation": "<p>An object that represents the specification of a GRPC route.</p>"
|
||||
"documentation": "<p>An object that represents the specification of a gRPC route.</p>"
|
||||
},
|
||||
"http2Route": {
|
||||
"shape": "HttpRoute",
|
||||
"documentation": "<p>An object that represents the specification of an HTTP2 route.</p>"
|
||||
"documentation": "<p>An object that represents the specification of an HTTP/2 route.</p>"
|
||||
},
|
||||
"httpRoute": {
|
||||
"shape": "HttpRoute",
|
||||
|
|
@ -3605,53 +2377,6 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a route specification. Specify one route type.</p>"
|
||||
},
|
||||
"HttpRoute": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"action",
|
||||
"match"
|
||||
],
|
||||
"members": {
|
||||
"action": {
|
||||
"shape": "HttpRouteAction",
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"match": {
|
||||
"shape": "HttpRouteMatch",
|
||||
"documentation": "<p>An object that represents the criteria for determining a request match.</p>"
|
||||
},
|
||||
"retryPolicy": {
|
||||
"shape": "HttpRetryPolicy",
|
||||
"documentation": "<p>An object that represents a retry policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents an HTTP or HTTP2 route type.</p>"
|
||||
},
|
||||
"DescribeMeshInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"MeshSpec": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"egressFilter": {
|
||||
"shape": "EgressFilter",
|
||||
"documentation": "<p>The egress filter rules for the service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the specification of a service mesh.</p>"
|
||||
},
|
||||
"CreateVirtualServiceOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3705,6 +2430,12 @@
|
|||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name of the virtual service to delete.</p>",
|
||||
|
|
@ -3714,6 +2445,1692 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"TlsValidationContext": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"trust"
|
||||
],
|
||||
"members": {
|
||||
"trust": {
|
||||
"shape": "TlsValidationContextTrust",
|
||||
"documentation": "<p>A reference to an object that represents a TLS validation context trust.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) validation context.</p>"
|
||||
},
|
||||
"DeleteVirtualRouterOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualRouter"
|
||||
],
|
||||
"members": {
|
||||
"virtualRouter": {
|
||||
"shape": "VirtualRouterData",
|
||||
"documentation": "<p>The virtual router that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "virtualRouter"
|
||||
},
|
||||
"TagsLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 50
|
||||
},
|
||||
"DeleteVirtualNodeOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualNode"
|
||||
],
|
||||
"members": {
|
||||
"virtualNode": {
|
||||
"shape": "VirtualNodeData",
|
||||
"documentation": "<p>The virtual node that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "virtualNode"
|
||||
},
|
||||
"UpdateVirtualNodeInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualNodeName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual node resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualNodeSpec",
|
||||
"documentation": "<p>The new virtual node specification to apply. This overwrites the existing data.</p>"
|
||||
},
|
||||
"virtualNodeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual node to update.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualNodeName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"ListenerTls": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"certificate",
|
||||
"mode"
|
||||
],
|
||||
"members": {
|
||||
"certificate": {
|
||||
"shape": "ListenerTlsCertificate",
|
||||
"documentation": "<p>A reference to an object that represents a listener's TLS certificate.</p>"
|
||||
},
|
||||
"mode": {
|
||||
"shape": "ListenerTlsMode",
|
||||
"documentation": "<p>Specify one of the following modes.</p>\n <ul>\n <li>\n <p>\n <b/>STRICT – Listener only accepts connections with TLS enabled. </p>\n </li>\n <li>\n <p>\n <b/>PERMISSIVE – Listener accepts connections with or without TLS enabled.</p>\n </li>\n <li>\n <p>\n <b/>DISABLED – Listener only accepts connections without TLS. </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the Transport Layer Security (TLS) properties for a listener.</p>"
|
||||
},
|
||||
"DeleteMeshInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to delete.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"TcpRetryPolicyEvents": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "TcpRetryPolicyEvent"
|
||||
},
|
||||
"min": 1,
|
||||
"max": 1
|
||||
},
|
||||
"CreateVirtualServiceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to create the virtual service in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualServiceSpec",
|
||||
"documentation": "<p>The virtual service specification to apply.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "TagList",
|
||||
"documentation": "<p>Optional metadata that you can apply to the virtual service to assist with\n categorization and organization. Each tag consists of a key and an optional value, both of\n which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>",
|
||||
"tags": [
|
||||
"not-preview"
|
||||
]
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name to use for the virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"UpdateVirtualRouterInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual router resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualRouterSpec",
|
||||
"documentation": "<p>The new virtual router specification to apply. This overwrites the existing data.</p>"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router to update.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"ListTagsForResourceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"resourceArn"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "TagsLimit",
|
||||
"documentation": "<p>The maximum number of tag results returned by <code>ListTagsForResource</code> in\n paginated output. When this parameter is used, <code>ListTagsForResource</code> returns\n only <code>limit</code> results in a single page along with a <code>nextToken</code>\n response element. You can see the remaining results of the initial request by sending\n another <code>ListTagsForResource</code> request with the returned <code>nextToken</code>\n value. This value can be between 1 and 100. If you don't use\n this parameter, <code>ListTagsForResource</code> returns up to 100\n results and a <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListTagsForResource</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
},
|
||||
"resourceArn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) that identifies the resource to list the tags for.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "resourceArn"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"GrpcRetryPolicyEvents": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "GrpcRetryPolicyEvent"
|
||||
},
|
||||
"min": 1,
|
||||
"max": 5
|
||||
},
|
||||
"ServiceUnavailableException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape": "String"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>The request has failed due to a temporary failure of the service.</p>",
|
||||
"exception": true,
|
||||
"error": {
|
||||
"code": "ServiceUnavailableException",
|
||||
"httpStatusCode": 503,
|
||||
"fault": true
|
||||
}
|
||||
},
|
||||
"DescribeMeshOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"mesh"
|
||||
],
|
||||
"members": {
|
||||
"mesh": {
|
||||
"shape": "MeshData",
|
||||
"documentation": "<p>The full description of your service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "mesh"
|
||||
},
|
||||
"DeleteVirtualRouterInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to delete the virtual router in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router to delete.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"DescribeRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"routeName",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the route resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"routeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the route to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "routeName"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router that the route is associated with.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"DeleteRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"route"
|
||||
],
|
||||
"members": {
|
||||
"route": {
|
||||
"shape": "RouteData",
|
||||
"documentation": "<p>The route that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "route"
|
||||
},
|
||||
"Listeners": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "Listener"
|
||||
},
|
||||
"min": 0,
|
||||
"max": 1
|
||||
},
|
||||
"Backends": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "Backend"
|
||||
}
|
||||
},
|
||||
"PortProtocol": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"grpc",
|
||||
"http",
|
||||
"http2",
|
||||
"tcp"
|
||||
]
|
||||
},
|
||||
"VirtualNodeStatusCode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ACTIVE",
|
||||
"DELETED",
|
||||
"INACTIVE"
|
||||
]
|
||||
},
|
||||
"ServiceName": {
|
||||
"type": "string"
|
||||
},
|
||||
"UpdateVirtualServiceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual service resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualServiceSpec",
|
||||
"documentation": "<p>The new virtual service specification to apply. This overwrites the existing\n data.</p>"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name of the virtual service to update.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualServiceName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"HealthCheckThreshold": {
|
||||
"type": "integer",
|
||||
"min": 2,
|
||||
"max": 10
|
||||
},
|
||||
"UpdateRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"route"
|
||||
],
|
||||
"members": {
|
||||
"route": {
|
||||
"shape": "RouteData",
|
||||
"documentation": "<p>A full description of the route that was updated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "route"
|
||||
},
|
||||
"PercentInt": {
|
||||
"type": "integer",
|
||||
"min": 0,
|
||||
"max": 100
|
||||
},
|
||||
"MethodName": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
"max": 50
|
||||
},
|
||||
"TagValue": {
|
||||
"type": "string",
|
||||
"min": 0,
|
||||
"max": 256
|
||||
},
|
||||
"HttpRouteAction": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"weightedTargets"
|
||||
],
|
||||
"members": {
|
||||
"weightedTargets": {
|
||||
"shape": "WeightedTargets",
|
||||
"documentation": "<p>An object that represents the targets that traffic is routed to when a request matches the route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"ListRoutesInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "ListRoutesLimit",
|
||||
"documentation": "<p>The maximum number of results returned by <code>ListRoutes</code> in paginated output.\n When you use this parameter, <code>ListRoutes</code> returns only <code>limit</code>\n results in a single page along with a <code>nextToken</code> response element. You can see\n the remaining results of the initial request by sending another <code>ListRoutes</code>\n request with the returned <code>nextToken</code> value. This value can be between\n 1 and 100. If you don't use this parameter,\n <code>ListRoutes</code> returns up to 100 results and a\n <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to list routes in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListRoutes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router to list routes in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"VirtualServiceRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"meshName",
|
||||
"meshOwner",
|
||||
"resourceOwner",
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"arn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The full Amazon Resource Name (ARN) for the virtual service.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual service resides in.</p>"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"resourceOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner, or another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name of the virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual service returned by a list operation.</p>"
|
||||
},
|
||||
"VirtualNodeStatus": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"status"
|
||||
],
|
||||
"members": {
|
||||
"status": {
|
||||
"shape": "VirtualNodeStatusCode",
|
||||
"documentation": "<p>The current status of the virtual node.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the current status of the virtual node.</p>"
|
||||
},
|
||||
"VirtualRouterRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"meshName",
|
||||
"meshOwner",
|
||||
"resourceOwner",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"arn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The full Amazon Resource Name (ARN) for the virtual router.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual router resides in.</p>"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"resourceOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner, or another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual router returned by a list operation.</p>"
|
||||
},
|
||||
"VirtualServiceData": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"metadata",
|
||||
"spec",
|
||||
"status",
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual service resides in.</p>"
|
||||
},
|
||||
"metadata": {
|
||||
"shape": "ResourceMetadata"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualServiceSpec",
|
||||
"documentation": "<p>The specifications of the virtual service.</p>"
|
||||
},
|
||||
"status": {
|
||||
"shape": "VirtualServiceStatus",
|
||||
"documentation": "<p>The current status of the virtual service.</p>"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name of the virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual service returned by a describe operation.</p>"
|
||||
},
|
||||
"HttpRouteHeader": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"name"
|
||||
],
|
||||
"members": {
|
||||
"invert": {
|
||||
"shape": "Boolean",
|
||||
"documentation": "<p>Specify <code>True</code> to match anything except the match criteria. The default value is <code>False</code>.</p>"
|
||||
},
|
||||
"match": {
|
||||
"shape": "HeaderMatchMethod",
|
||||
"documentation": "<p>The <code>HeaderMatchMethod</code> object.</p>"
|
||||
},
|
||||
"name": {
|
||||
"shape": "HeaderName",
|
||||
"documentation": "<p>A name for the HTTP header in the client request that will be matched on.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the HTTP header in the request.</p>"
|
||||
},
|
||||
"FilePath": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"AwsCloudMapInstanceAttributes": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "AwsCloudMapInstanceAttribute"
|
||||
}
|
||||
},
|
||||
"VirtualNodeRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"meshName",
|
||||
"meshOwner",
|
||||
"resourceOwner",
|
||||
"virtualNodeName"
|
||||
],
|
||||
"members": {
|
||||
"arn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The full Amazon Resource Name (ARN) for the virtual node.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual node resides in.</p>"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"resourceOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner, or another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"virtualNodeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual node.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual node returned by a list operation.</p>"
|
||||
},
|
||||
"CreateMeshInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name to use for the service mesh.</p>"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "MeshSpec",
|
||||
"documentation": "<p>The service mesh specification to apply.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "TagList",
|
||||
"documentation": "<p>Optional metadata that you can apply to the service mesh to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>",
|
||||
"tags": [
|
||||
"not-preview"
|
||||
]
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"GrpcRouteAction": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"weightedTargets"
|
||||
],
|
||||
"members": {
|
||||
"weightedTargets": {
|
||||
"shape": "WeightedTargets",
|
||||
"documentation": "<p>An object that represents the targets that traffic is routed to when a request matches the route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape": "String"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>You have exceeded a service limit for your account. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/service_limits.html\">Service\n Limits</a> in the <i>AWS App Mesh User Guide</i>.</p>",
|
||||
"exception": true,
|
||||
"error": {
|
||||
"code": "LimitExceededException",
|
||||
"httpStatusCode": 400,
|
||||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"UpdateMeshOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"mesh"
|
||||
],
|
||||
"members": {
|
||||
"mesh": {
|
||||
"shape": "MeshData"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "mesh"
|
||||
},
|
||||
"GrpcRouteMetadataMatchMethod": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"exact": {
|
||||
"shape": "HeaderMatch",
|
||||
"documentation": "<p>The value sent by the client must match the specified value exactly.</p>"
|
||||
},
|
||||
"prefix": {
|
||||
"shape": "HeaderMatch",
|
||||
"documentation": "<p>The value sent by the client must begin with the specified characters.</p>"
|
||||
},
|
||||
"range": {
|
||||
"shape": "MatchRange",
|
||||
"documentation": "<p>An object that represents the range of values to match on.</p>"
|
||||
},
|
||||
"regex": {
|
||||
"shape": "HeaderMatch",
|
||||
"documentation": "<p>The value sent by the client must include the specified characters.</p>"
|
||||
},
|
||||
"suffix": {
|
||||
"shape": "HeaderMatch",
|
||||
"documentation": "<p>The value sent by the client must end with the specified characters.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the match method. Specify one of the match values.</p>"
|
||||
},
|
||||
"DescribeVirtualServiceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual service resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"virtualServiceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The name of the virtual service to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualServiceName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"ListVirtualServicesLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"AwsCloudMapInstanceAttribute": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"key",
|
||||
"value"
|
||||
],
|
||||
"members": {
|
||||
"key": {
|
||||
"shape": "AwsCloudMapInstanceAttributeKey",
|
||||
"documentation": "<p>The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service\n instance that contains the specified key and value is returned.</p>"
|
||||
},
|
||||
"value": {
|
||||
"shape": "AwsCloudMapInstanceAttributeValue",
|
||||
"documentation": "<p>The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service\n instance that contains the specified key and value is returned.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the AWS Cloud Map attribute information for your virtual\n node.</p>"
|
||||
},
|
||||
"VirtualServiceSpec": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"provider": {
|
||||
"shape": "VirtualServiceProvider",
|
||||
"documentation": "<p>The App Mesh object that is acting as the provider for a virtual service. You can specify\n a single virtual node or virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the specification of a virtual service.</p>"
|
||||
},
|
||||
"MatchRange": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"end",
|
||||
"start"
|
||||
],
|
||||
"members": {
|
||||
"end": {
|
||||
"shape": "Long",
|
||||
"documentation": "<p>The end of the range.</p>"
|
||||
},
|
||||
"start": {
|
||||
"shape": "Long",
|
||||
"documentation": "<p>The start of the range.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.</p>"
|
||||
},
|
||||
"ListVirtualRoutersLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"HealthCheckIntervalMillis": {
|
||||
"type": "long",
|
||||
"box": true,
|
||||
"min": 5000,
|
||||
"max": 300000
|
||||
},
|
||||
"VirtualRouterList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "VirtualRouterRef"
|
||||
}
|
||||
},
|
||||
"Arn": {
|
||||
"type": "string"
|
||||
},
|
||||
"TcpRoute": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"action"
|
||||
],
|
||||
"members": {
|
||||
"action": {
|
||||
"shape": "TcpRouteAction",
|
||||
"documentation": "<p>The action to take if a match is determined.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a TCP route type.</p>"
|
||||
},
|
||||
"VirtualNodeList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "VirtualNodeRef"
|
||||
}
|
||||
},
|
||||
"ListVirtualRoutersInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "ListVirtualRoutersLimit",
|
||||
"documentation": "<p>The maximum number of results returned by <code>ListVirtualRouters</code> in paginated\n output. When you use this parameter, <code>ListVirtualRouters</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualRouters</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualRouters</code> returns up to 100 results and\n a <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to list virtual routers in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualRouters</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"DurationUnit": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ms",
|
||||
"s"
|
||||
]
|
||||
},
|
||||
"RoutePriority": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 0,
|
||||
"max": 1000
|
||||
},
|
||||
"ListVirtualServicesInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "ListVirtualServicesLimit",
|
||||
"documentation": "<p>The maximum number of results returned by <code>ListVirtualServices</code> in paginated\n output. When you use this parameter, <code>ListVirtualServices</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualServices</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualServices</code> returns up to 100 results and\n a <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to list virtual services in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualServices</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"AccessLog": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"file": {
|
||||
"shape": "FileAccessLog",
|
||||
"documentation": "<p>The file object to send virtual node access logs to.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the access logging information for a virtual node.</p>"
|
||||
},
|
||||
"ListVirtualNodesInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "ListVirtualNodesLimit",
|
||||
"documentation": "<p>The maximum number of results returned by <code>ListVirtualNodes</code> in paginated\n output. When you use this parameter, <code>ListVirtualNodes</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualNodes</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualNodes</code> returns up to 100 results and a\n <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to list virtual nodes in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualNodes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"ListVirtualNodesLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"HealthCheckTimeoutMillis": {
|
||||
"type": "long",
|
||||
"box": true,
|
||||
"min": 2000,
|
||||
"max": 60000
|
||||
},
|
||||
"ResourceName": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"TooManyRequestsException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape": "String"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>The maximum request rate permitted by the App Mesh APIs has been exceeded for your\n account. For best results, use an increasing or variable sleep interval between\n requests.</p>",
|
||||
"exception": true,
|
||||
"error": {
|
||||
"code": "TooManyRequestsException",
|
||||
"httpStatusCode": 429,
|
||||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"Timestamp": {
|
||||
"type": "timestamp"
|
||||
},
|
||||
"HeaderMatch": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
"max": 255
|
||||
},
|
||||
"AccountId": {
|
||||
"type": "string",
|
||||
"min": 12,
|
||||
"max": 12
|
||||
},
|
||||
"Duration": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"unit": {
|
||||
"shape": "DurationUnit",
|
||||
"documentation": "<p>A unit of time.</p>"
|
||||
},
|
||||
"value": {
|
||||
"shape": "DurationValue",
|
||||
"documentation": "<p>A number of time units.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a duration of time.</p>"
|
||||
},
|
||||
"DescribeRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"route"
|
||||
],
|
||||
"members": {
|
||||
"route": {
|
||||
"shape": "RouteData",
|
||||
"documentation": "<p>The full description of your route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "route"
|
||||
},
|
||||
"HttpRouteMatch": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"prefix"
|
||||
],
|
||||
"members": {
|
||||
"headers": {
|
||||
"shape": "HttpRouteHeaders",
|
||||
"documentation": "<p>An object that represents the client request headers to match on.</p>"
|
||||
},
|
||||
"method": {
|
||||
"shape": "HttpMethod",
|
||||
"documentation": "<p>The client request method to match on. Specify only one.</p>"
|
||||
},
|
||||
"prefix": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Specifies the path to match requests with. This parameter must always start with\n <code>/</code>, which by itself matches all requests to the virtual service name. You\n can also match for path-based routing of requests. For example, if your virtual service\n name is <code>my-service.local</code> and you want the route to match requests to\n <code>my-service.local/metrics</code>, your prefix should be\n <code>/metrics</code>.</p>"
|
||||
},
|
||||
"scheme": {
|
||||
"shape": "HttpScheme",
|
||||
"documentation": "<p>The client request scheme to match on. Specify only one.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the requirements for a route to match HTTP requests for a virtual\n router.</p>"
|
||||
},
|
||||
"TagRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"key"
|
||||
],
|
||||
"members": {
|
||||
"key": {
|
||||
"shape": "TagKey",
|
||||
"documentation": "<p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label\n that acts like a category for more specific tag values.</p>"
|
||||
},
|
||||
"value": {
|
||||
"shape": "TagValue",
|
||||
"documentation": "<p>The optional part of a key-value pair that make up a tag. A <code>value</code> acts as a\n descriptor within a tag category (key).</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Optional metadata that you apply to a resource to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
},
|
||||
"MeshRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"meshName",
|
||||
"meshOwner",
|
||||
"resourceOwner"
|
||||
],
|
||||
"members": {
|
||||
"arn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The full Amazon Resource Name (ARN) of the service mesh.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh.</p>"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
},
|
||||
"resourceOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner, or another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a service mesh returned by a list operation.</p>"
|
||||
},
|
||||
"MeshStatusCode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ACTIVE",
|
||||
"DELETED",
|
||||
"INACTIVE"
|
||||
]
|
||||
},
|
||||
"MeshData": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"metadata",
|
||||
"spec",
|
||||
"status"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh.</p>"
|
||||
},
|
||||
"metadata": {
|
||||
"shape": "ResourceMetadata",
|
||||
"documentation": "<p>The associated metadata for the service mesh.</p>"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "MeshSpec",
|
||||
"documentation": "<p>The associated specification for the service mesh.</p>"
|
||||
},
|
||||
"status": {
|
||||
"shape": "MeshStatus",
|
||||
"documentation": "<p>The status of the service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a service mesh returned by a describe operation.</p>"
|
||||
},
|
||||
"VirtualRouterStatus": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"status"
|
||||
],
|
||||
"members": {
|
||||
"status": {
|
||||
"shape": "VirtualRouterStatusCode",
|
||||
"documentation": "<p>The current status of the virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the status of a virtual router. </p>"
|
||||
},
|
||||
"TcpRouteAction": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"weightedTargets"
|
||||
],
|
||||
"members": {
|
||||
"weightedTargets": {
|
||||
"shape": "WeightedTargets",
|
||||
"documentation": "<p>An object that represents the targets that traffic is routed to when a request matches the route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"DescribeVirtualNodeInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualNodeName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual node resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"virtualNodeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual node to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualNodeName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"RouteStatus": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"status"
|
||||
],
|
||||
"members": {
|
||||
"status": {
|
||||
"shape": "RouteStatusCode",
|
||||
"documentation": "<p>The current status for the route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the current status of a route.</p>"
|
||||
},
|
||||
"Listener": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"portMapping"
|
||||
],
|
||||
"members": {
|
||||
"healthCheck": {
|
||||
"shape": "HealthCheckPolicy",
|
||||
"documentation": "<p>The health check information for the listener.</p>"
|
||||
},
|
||||
"portMapping": {
|
||||
"shape": "PortMapping",
|
||||
"documentation": "<p>The port mapping information for the listener.</p>"
|
||||
},
|
||||
"tls": {
|
||||
"shape": "ListenerTls",
|
||||
"documentation": "<p>A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a listener for a virtual node.</p>"
|
||||
},
|
||||
"GrpcRoute": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"action",
|
||||
"match"
|
||||
],
|
||||
"members": {
|
||||
"action": {
|
||||
"shape": "GrpcRouteAction",
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"match": {
|
||||
"shape": "GrpcRouteMatch",
|
||||
"documentation": "<p>An object that represents the criteria for determining a request match.</p>"
|
||||
},
|
||||
"retryPolicy": {
|
||||
"shape": "GrpcRetryPolicy",
|
||||
"documentation": "<p>An object that represents a retry policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a gRPC route type.</p>"
|
||||
},
|
||||
"ListRoutesLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"ClientPolicyTls": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"validation"
|
||||
],
|
||||
"members": {
|
||||
"enforce": {
|
||||
"shape": "Boolean",
|
||||
"box": true,
|
||||
"documentation": "<p>Whether the policy is enforced. The default is <code>True</code>, if a value isn't specified.</p>"
|
||||
},
|
||||
"ports": {
|
||||
"shape": "PortSet",
|
||||
"documentation": "<p>The range of ports that the policy is enforced for.</p>"
|
||||
},
|
||||
"validation": {
|
||||
"shape": "TlsValidationContext",
|
||||
"documentation": "<p>A reference to an object that represents a TLS validation context.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) client policy.</p>"
|
||||
},
|
||||
"DeleteVirtualServiceOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualService"
|
||||
],
|
||||
"members": {
|
||||
"virtualService": {
|
||||
"shape": "VirtualServiceData",
|
||||
"documentation": "<p>The virtual service that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "virtualService"
|
||||
},
|
||||
"VirtualNodeServiceProvider": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualNodeName"
|
||||
],
|
||||
"members": {
|
||||
"virtualNodeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual node that is acting as a service provider.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual node service provider.</p>"
|
||||
},
|
||||
"BackendDefaults": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"clientPolicy": {
|
||||
"shape": "ClientPolicy",
|
||||
"documentation": "<p>A reference to an object that represents a client policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the default properties for a backend.</p>"
|
||||
},
|
||||
"ListenerTlsFileCertificate": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"certificateChain",
|
||||
"privateKey"
|
||||
],
|
||||
"members": {
|
||||
"certificateChain": {
|
||||
"shape": "FilePath",
|
||||
"documentation": "<p>The certificate chain for the certificate.</p>"
|
||||
},
|
||||
"privateKey": {
|
||||
"shape": "FilePath",
|
||||
"documentation": "<p>The private key for a certificate stored on the file system of the virtual node that the proxy is running on.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual-node-tls.html#virtual-node-tls-prerequisites\">Transport Layer Security (TLS)</a>.</p>"
|
||||
},
|
||||
"HttpRetryPolicy": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"maxRetries",
|
||||
"perRetryTimeout"
|
||||
],
|
||||
"members": {
|
||||
"httpRetryEvents": {
|
||||
"shape": "HttpRetryPolicyEvents",
|
||||
"documentation": "<p>Specify at least one of the following values.</p>\n <ul>\n <li>\n <p>\n <b>server-error</b> – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511</p>\n </li>\n <li>\n <p>\n <b>gateway-error</b> – HTTP status codes 502,\n 503, and 504</p>\n </li>\n <li>\n <p>\n <b>client-error</b> – HTTP status code 409</p>\n </li>\n <li>\n <p>\n <b>stream-error</b> – Retry on refused\n stream</p>\n </li>\n </ul>"
|
||||
},
|
||||
"maxRetries": {
|
||||
"shape": "MaxRetries",
|
||||
"documentation": "<p>The maximum number of retry attempts.</p>"
|
||||
},
|
||||
"perRetryTimeout": {
|
||||
"shape": "Duration",
|
||||
"documentation": "<p>An object that represents a duration of time.</p>"
|
||||
},
|
||||
"tcpRetryEvents": {
|
||||
"shape": "TcpRetryPolicyEvents",
|
||||
"documentation": "<p>Specify a valid value.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a retry policy. Specify at least one value for at least one of the types of <code>RetryEvents</code>, a value for <code>maxRetries</code>, and a value for <code>perRetryTimeout</code>.</p>"
|
||||
},
|
||||
"DescribeVirtualRouterInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual router resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"TagResourceOutput": {
|
||||
"type": "structure",
|
||||
"members": { },
|
||||
"documentation": ""
|
||||
},
|
||||
"RouteList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "RouteRef"
|
||||
}
|
||||
},
|
||||
"TooManyTagsException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"message": {
|
||||
"shape": "String"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>The request exceeds the maximum allowed number of tags allowed per resource. The current\n limit is 50 user tags per resource. You must reduce the number of tags in the request. None\n of the tags in this request were applied.</p>",
|
||||
"exception": true,
|
||||
"error": {
|
||||
"code": "TooManyTagsException",
|
||||
"httpStatusCode": 400,
|
||||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"PortNumber": {
|
||||
"type": "integer",
|
||||
"min": 1,
|
||||
"max": 65535
|
||||
},
|
||||
"TlsValidationContextFileTrust": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"certificateChain"
|
||||
],
|
||||
"members": {
|
||||
"certificateChain": {
|
||||
"shape": "FilePath",
|
||||
"documentation": "<p>The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) validation context trust for a local file.</p>"
|
||||
},
|
||||
"GrpcRouteMetadata": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"name"
|
||||
],
|
||||
"members": {
|
||||
"invert": {
|
||||
"shape": "Boolean",
|
||||
"documentation": "<p>Specify <code>True</code> to match anything except the match criteria. The default value is <code>False</code>.</p>"
|
||||
},
|
||||
"match": {
|
||||
"shape": "GrpcRouteMetadataMatchMethod",
|
||||
"documentation": "<p>An object that represents the data to match from the request.</p>"
|
||||
},
|
||||
"name": {
|
||||
"shape": "HeaderName",
|
||||
"documentation": "<p>The name of the route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the match metadata for the route.</p>"
|
||||
},
|
||||
"CreateRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"routeName",
|
||||
"spec",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to create the route in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"routeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name to use for the route.</p>"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "RouteSpec",
|
||||
"documentation": "<p>The route specification to apply.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "TagList",
|
||||
"documentation": "<p>Optional metadata that you can apply to the route to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>",
|
||||
"tags": [
|
||||
"not-preview"
|
||||
]
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router in which to create the route. If the virtual router is in a shared mesh,\n then you must be the owner of the virtual router resource.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"WeightedTargets": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "WeightedTarget"
|
||||
},
|
||||
"min": 1,
|
||||
"max": 10
|
||||
},
|
||||
"HttpRouteHeaders": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "HttpRouteHeader"
|
||||
},
|
||||
"min": 1,
|
||||
"max": 10
|
||||
},
|
||||
"String": {
|
||||
"type": "string"
|
||||
},
|
||||
"HttpScheme": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"http",
|
||||
"https"
|
||||
]
|
||||
},
|
||||
"UpdateRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"routeName",
|
||||
"spec",
|
||||
"virtualRouterName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the route resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"routeName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the route to update.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "routeName"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "RouteSpec",
|
||||
"documentation": "<p>The new route specification to apply. This overwrites the existing data.</p>"
|
||||
},
|
||||
"virtualRouterName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual router that the route is associated with.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualRouterName"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"HttpRoute": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"action",
|
||||
"match"
|
||||
],
|
||||
"members": {
|
||||
"action": {
|
||||
"shape": "HttpRouteAction",
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"match": {
|
||||
"shape": "HttpRouteMatch",
|
||||
"documentation": "<p>An object that represents the criteria for determining a request match.</p>"
|
||||
},
|
||||
"retryPolicy": {
|
||||
"shape": "HttpRetryPolicy",
|
||||
"documentation": "<p>An object that represents a retry policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents an HTTP or HTTP/2 route type.</p>"
|
||||
},
|
||||
"DescribeMeshInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with Shared Meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
}
|
||||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"MeshSpec": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"egressFilter": {
|
||||
"shape": "EgressFilter",
|
||||
"documentation": "<p>The egress filter rules for the service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the specification of a service mesh.</p>"
|
||||
},
|
||||
"ListTagsForResourceOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3782,25 +4199,18 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"DeleteVirtualRouterOutput": {
|
||||
"ListenerTlsAcmCertificate": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualRouter"
|
||||
"certificateArn"
|
||||
],
|
||||
"members": {
|
||||
"virtualRouter": {
|
||||
"shape": "VirtualRouterData",
|
||||
"documentation": "<p>The virtual router that was deleted.</p>"
|
||||
"certificateArn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual-node-tls.html#virtual-node-tls-prerequisites\">Transport Layer Security (TLS)</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "virtualRouter"
|
||||
},
|
||||
"TagsLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 50
|
||||
"documentation": "<p>An object that represents an AWS Certicate Manager (ACM) certificate.</p>"
|
||||
},
|
||||
"TagKey": {
|
||||
"type": "string",
|
||||
|
|
@ -3814,20 +4224,6 @@
|
|||
"DELETED",
|
||||
"INACTIVE"
|
||||
]
|
||||
},
|
||||
"DeleteVirtualNodeOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualNode"
|
||||
],
|
||||
"members": {
|
||||
"virtualNode": {
|
||||
"shape": "VirtualNodeData",
|
||||
"documentation": "<p>The virtual node that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "",
|
||||
"payload": "virtualNode"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@
|
|||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
],
|
||||
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Service Quotas</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"CreateLaunchConfiguration":{
|
||||
"name":"CreateLaunchConfiguration",
|
||||
|
|
@ -135,7 +135,7 @@
|
|||
{"shape":"LimitExceededFault"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Service Quotas</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"CreateOrUpdateTags":{
|
||||
"name":"CreateOrUpdateTags",
|
||||
|
|
@ -258,7 +258,7 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Describes the current Amazon EC2 Auto Scaling resource limits for your AWS account.</p> <p>For information about requesting an increase in these limits, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account.</p> <p>For information about requesting an increase, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Service Quotas</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"DescribeAdjustmentTypes":{
|
||||
"name":"DescribeAdjustmentTypes",
|
||||
|
|
@ -699,7 +699,7 @@
|
|||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
],
|
||||
"documentation":"<p>Creates or updates a scaling policy for an Auto Scaling group. To update an existing scaling policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.</p> <p>For more information about using scaling policies to scale your Auto Scaling group automatically, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Creates or updates a scaling policy for an Auto Scaling group.</p> <p>For more information about using scaling policies to scale your Auto Scaling group automatically, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"PutScheduledUpdateGroupAction":{
|
||||
"name":"PutScheduledUpdateGroupAction",
|
||||
|
|
@ -814,7 +814,7 @@
|
|||
{"shape":"ScalingActivityInProgressFault"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Terminates the specified instance and optionally adjusts the desired group size.</p> <p>This call simply makes a termination request. The instance is not terminated immediately.</p>"
|
||||
"documentation":"<p>Terminates the specified instance and optionally adjusts the desired group size. This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to <code>terminated</code>. You can't connect to or start an instance after you've terminated it.</p> <p>If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated. </p> <p>By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-benefits.html#AutoScalingBehavior.InstanceUsage\">Rebalancing Activities</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"UpdateAutoScalingGroup":{
|
||||
"name":"UpdateAutoScalingGroup",
|
||||
|
|
@ -1501,7 +1501,7 @@
|
|||
},
|
||||
"MaxInstanceLifetime":{
|
||||
"shape":"MaxInstanceLifetime",
|
||||
"documentation":"<p>The maximum amount of time, in seconds, that an instance can be in service.</p> <p>Valid Range: Minimum value of 604800.</p>"
|
||||
"documentation":"<p>The maximum amount of time, in seconds, that an instance can be in service.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html\">Replacing Auto Scaling Instances Based on Maximum Instance Lifetime</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Valid Range: Minimum value of 604800.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1723,11 +1723,11 @@
|
|||
"members":{
|
||||
"MaxNumberOfAutoScalingGroups":{
|
||||
"shape":"MaxNumberOfAutoScalingGroups",
|
||||
"documentation":"<p>The maximum number of groups allowed for your AWS account. The default limit is 200 per AWS Region.</p>"
|
||||
"documentation":"<p>The maximum number of groups allowed for your AWS account. The default is 200 groups per AWS Region.</p>"
|
||||
},
|
||||
"MaxNumberOfLaunchConfigurations":{
|
||||
"shape":"MaxNumberOfLaunchConfigurations",
|
||||
"documentation":"<p>The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per AWS Region.</p>"
|
||||
"documentation":"<p>The maximum number of launch configurations allowed for your AWS account. The default is 200 launch configurations per AWS Region.</p>"
|
||||
},
|
||||
"NumberOfAutoScalingGroups":{
|
||||
"shape":"NumberOfAutoScalingGroups",
|
||||
|
|
@ -2578,7 +2578,7 @@
|
|||
},
|
||||
"WeightedCapacity":{
|
||||
"shape":"XmlStringMaxLen32",
|
||||
"documentation":"<p>The number of capacity units, which gives the instance type a proportional weight to other instance types. For example, larger instance types are generally weighted more than smaller instance types. These are the same units that you chose to set the desired capacity in terms of instances, or a performance attribute such as vCPUs, memory, or I/O.</p> <p>Valid Range: Minimum value of 1. Maximum value of 999.</p>"
|
||||
"documentation":"<p>The number of capacity units, which gives the instance type a proportional weight to other instance types. For example, larger instance types are generally weighted more than smaller instance types. These are the same units that you chose to set the desired capacity in terms of instances, or a performance attribute such as vCPUs, memory, or I/O.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html\">Instance Weighting for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Valid Range: Minimum value of 1. Maximum value of 999.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes an override for a launch template.</p>"
|
||||
|
|
@ -3124,6 +3124,10 @@
|
|||
"TargetTrackingConfiguration":{
|
||||
"shape":"TargetTrackingConfiguration",
|
||||
"documentation":"<p>A target tracking scaling policy. Includes support for predefined or customized metrics.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html\">TargetTrackingConfiguration</a> in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>Conditional: If you specify <code>TargetTrackingScaling</code> for the policy type, you must specify this parameter. (Not used with any other policy type.) </p>"
|
||||
},
|
||||
"Enabled":{
|
||||
"shape":"ScalingPolicyEnabled",
|
||||
"documentation":"<p>Indicates whether the scaling policy is enabled or disabled. The default is enabled. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html\">Disabling a Scaling Policy for an Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3335,10 +3339,15 @@
|
|||
"TargetTrackingConfiguration":{
|
||||
"shape":"TargetTrackingConfiguration",
|
||||
"documentation":"<p>A target tracking scaling policy.</p>"
|
||||
},
|
||||
"Enabled":{
|
||||
"shape":"ScalingPolicyEnabled",
|
||||
"documentation":"<p>Indicates whether the policy is enabled (<code>true</code>) or disabled (<code>false</code>).</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes a scaling policy.</p>"
|
||||
},
|
||||
"ScalingPolicyEnabled":{"type":"boolean"},
|
||||
"ScalingProcessQuery":{
|
||||
"type":"structure",
|
||||
"required":["AutoScalingGroupName"],
|
||||
|
|
@ -3799,7 +3808,7 @@
|
|||
},
|
||||
"MaxInstanceLifetime":{
|
||||
"shape":"MaxInstanceLifetime",
|
||||
"documentation":"<p>The maximum amount of time, in seconds, that an instance can be in service.</p> <p>Valid Range: Minimum value of 604800.</p>"
|
||||
"documentation":"<p>The maximum amount of time, in seconds, that an instance can be in service.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html\">Replacing Auto Scaling Instances Based on Maximum Instance Lifetime</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Valid Range: Minimum value of 604800.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -132,7 +132,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Adds up to 50 members to a chat room. Members can be either users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.</p>"
|
||||
"documentation":"<p>Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be either users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.</p>"
|
||||
},
|
||||
"BatchDeletePhoneNumber":{
|
||||
"name":"BatchDeletePhoneNumber",
|
||||
|
|
@ -356,7 +356,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates a chat room for the specified Amazon Chime account.</p>"
|
||||
"documentation":"<p>Creates a chat room for the specified Amazon Chime Enterprise account.</p>"
|
||||
},
|
||||
"CreateRoomMembership":{
|
||||
"name":"CreateRoomMembership",
|
||||
|
|
@ -378,7 +378,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Adds a member to a chat room. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.</p>"
|
||||
"documentation":"<p>Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.</p>"
|
||||
},
|
||||
"CreateUser":{
|
||||
"name":"CreateUser",
|
||||
|
|
@ -441,7 +441,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate up to three existing Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including <code>VoiceConnectorItems</code> in the request.</p> <p>You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.</p>"
|
||||
"documentation":"<p>Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including <code>VoiceConnectorItems</code> in the request.</p> <p>You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.</p>"
|
||||
},
|
||||
"DeleteAccount":{
|
||||
"name":"DeleteAccount",
|
||||
|
|
@ -556,7 +556,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a chat room.</p>"
|
||||
"documentation":"<p>Deletes a chat room in an Amazon Chime Enterprise account.</p>"
|
||||
},
|
||||
"DeleteRoomMembership":{
|
||||
"name":"DeleteRoomMembership",
|
||||
|
|
@ -575,7 +575,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Removes a member from a chat room.</p>"
|
||||
"documentation":"<p>Removes a member from a chat room in an Amazon Chime Enterprise account.</p>"
|
||||
},
|
||||
"DeleteVoiceConnector":{
|
||||
"name":"DeleteVoiceConnector",
|
||||
|
|
@ -984,7 +984,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves room details, such as the room name.</p>"
|
||||
"documentation":"<p>Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.</p>"
|
||||
},
|
||||
"GetUser":{
|
||||
"name":"GetUser",
|
||||
|
|
@ -1319,7 +1319,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Lists the membership details for the specified room, such as the members' IDs, email addresses, and names.</p>"
|
||||
"documentation":"<p>Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.</p>"
|
||||
},
|
||||
"ListRooms":{
|
||||
"name":"ListRooms",
|
||||
|
|
@ -1339,7 +1339,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Lists the room details for the specified Amazon Chime account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.</p>"
|
||||
"documentation":"<p>Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.</p>"
|
||||
},
|
||||
"ListUsers":{
|
||||
"name":"ListUsers",
|
||||
|
|
@ -1774,7 +1774,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Updates room details, such as the room name.</p>"
|
||||
"documentation":"<p>Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.</p>"
|
||||
},
|
||||
"UpdateRoomMembership":{
|
||||
"name":"UpdateRoomMembership",
|
||||
|
|
@ -1794,7 +1794,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Updates room membership details, such as the member role. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.</p>"
|
||||
"documentation":"<p>Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.</p>"
|
||||
},
|
||||
"UpdateUser":{
|
||||
"name":"UpdateUser",
|
||||
|
|
@ -4198,6 +4198,10 @@
|
|||
"shape":"UriType",
|
||||
"documentation":"<p>The audio host URL.</p>"
|
||||
},
|
||||
"AudioFallbackUrl":{
|
||||
"shape":"UriType",
|
||||
"documentation":"<p>The audio fallback URL.</p>"
|
||||
},
|
||||
"ScreenDataUrl":{
|
||||
"shape":"UriType",
|
||||
"documentation":"<p>The screen data URL.</p>"
|
||||
|
|
@ -5145,7 +5149,7 @@
|
|||
"members":{
|
||||
"CpsLimit":{
|
||||
"shape":"CpsLimit",
|
||||
"documentation":"<p>The limit on calls per second. Max value based on account service limit. Default value of 1.</p>"
|
||||
"documentation":"<p>The limit on calls per second. Max value based on account service quota. Default value of 1.</p>"
|
||||
},
|
||||
"DefaultPhoneNumber":{
|
||||
"shape":"E164PhoneNumber",
|
||||
|
|
|
|||
|
|
@ -168,6 +168,51 @@
|
|||
],
|
||||
"documentation":"<p>Gets a list of AWS Cloud9 development environment identifiers.</p>"
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListTagsForResourceRequest"},
|
||||
"output":{"shape":"ListTagsForResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServerErrorException"},
|
||||
{"shape":"BadRequestException"}
|
||||
],
|
||||
"documentation":"<p>Gets a list of the tags associated with an AWS Cloud9 development environment.</p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"TagResourceRequest"},
|
||||
"output":{"shape":"TagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServerErrorException"},
|
||||
{"shape":"BadRequestException"}
|
||||
],
|
||||
"documentation":"<p>Adds tags to an AWS Cloud9 development environment.</p> <important> <p>Tags that you add to an AWS Cloud9 environment by using this method will NOT be automatically propagated to underlying resources.</p> </important>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UntagResourceRequest"},
|
||||
"output":{"shape":"UntagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalServerErrorException"},
|
||||
{"shape":"BadRequestException"}
|
||||
],
|
||||
"documentation":"<p>Removes tags from an AWS Cloud9 development environment.</p>"
|
||||
},
|
||||
"UpdateEnvironment":{
|
||||
"name":"UpdateEnvironment",
|
||||
"http":{
|
||||
|
|
@ -273,6 +318,10 @@
|
|||
"ownerArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -467,6 +516,10 @@
|
|||
},
|
||||
"documentation":"<p>Information about an AWS Cloud9 development environment.</p>"
|
||||
},
|
||||
"EnvironmentArn":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws:cloud9:([a-z]{2}-[a-z]+-\\d{1}):[0-9]{12}:environment:[a-zA-Z0-9]{8,32}"
|
||||
},
|
||||
"EnvironmentDescription":{
|
||||
"type":"string",
|
||||
"max":200,
|
||||
|
|
@ -620,6 +673,25 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceARN"],
|
||||
"members":{
|
||||
"ResourceARN":{
|
||||
"shape":"EnvironmentArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to get the tags for.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The list of tags associated with the AWS Cloud9 development environment.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
|
|
@ -658,6 +730,68 @@
|
|||
"max":30,
|
||||
"min":5
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Key",
|
||||
"Value"
|
||||
],
|
||||
"members":{
|
||||
"Key":{
|
||||
"shape":"TagKey",
|
||||
"documentation":"<p>The <b>name</b> part of a tag.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"TagValue",
|
||||
"documentation":"<p>The <b>value</b> part of a tag.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Metadata that is associated with AWS resources. In particular, a name-value pair that can be associated with an AWS Cloud9 development environment. There are two types of tags: <i>user tags</i> and <i>system tags</i>. A user tag is created by the user. A system tag is automatically created by AWS services. A system tag is prefixed with \"aws:\" and cannot be modified by the user.</p>"
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1
|
||||
},
|
||||
"TagKeyList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TagKey"},
|
||||
"max":200,
|
||||
"min":0
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Tag"},
|
||||
"max":200,
|
||||
"min":0
|
||||
},
|
||||
"TagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceARN",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"ResourceARN":{
|
||||
"shape":"EnvironmentArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to add tags to.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The list of tags to add to the given AWS Cloud9 development environment.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"TagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"TooManyRequestsException":{
|
||||
"type":"structure",
|
||||
|
|
@ -666,6 +800,28 @@
|
|||
"documentation":"<p>Too many service requests were made over the given time period.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"UntagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceARN",
|
||||
"TagKeys"
|
||||
],
|
||||
"members":{
|
||||
"ResourceARN":{
|
||||
"shape":"EnvironmentArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Cloud9 development environment to remove tags from.</p>"
|
||||
},
|
||||
"TagKeys":{
|
||||
"shape":"TagKeyList",
|
||||
"documentation":"<p>The tag names of the tags to remove from the given AWS Cloud9 development environment.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UntagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateEnvironmentMembershipRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -722,8 +878,8 @@
|
|||
},
|
||||
"UserArn":{
|
||||
"type":"string",
|
||||
"pattern":"^arn:aws:(iam|sts)::\\d+:(root|(user\\/[\\w+=/:,.@-]{1,64}|federated-user\\/[\\w+=/:,.@-]{2,32}|assumed-role\\/[\\w+=/:,.@-]{1,64}\\/[\\w+=/:,.@-]{1,64}))$"
|
||||
"pattern":"^arn:aws:(iam|sts)::\\d+:(root|(user\\/[\\w+=/:,.@-]{1,64}|federated-user\\/[\\w+=/:,.@-]{2,32}|assumed-role\\/[\\w+=:,.@-]{1,64}\\/[\\w+=,.@-]{1,64}))$"
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>AWS Cloud9</fullname> <p>AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.</p> <p>For more information about AWS Cloud9, see the <a href=\"https://docs.aws.amazon.com/cloud9/latest/user-guide\">AWS Cloud9 User Guide</a>.</p> <p>AWS Cloud9 supports these operations:</p> <ul> <li> <p> <code>CreateEnvironmentEC2</code>: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.</p> </li> <li> <p> <code>CreateEnvironmentMembership</code>: Adds an environment member to an environment.</p> </li> <li> <p> <code>DeleteEnvironment</code>: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.</p> </li> <li> <p> <code>DeleteEnvironmentMembership</code>: Deletes an environment member from an environment.</p> </li> <li> <p> <code>DescribeEnvironmentMemberships</code>: Gets information about environment members for an environment.</p> </li> <li> <p> <code>DescribeEnvironments</code>: Gets information about environments.</p> </li> <li> <p> <code>DescribeEnvironmentStatus</code>: Gets status information for an environment.</p> </li> <li> <p> <code>ListEnvironments</code>: Gets a list of environment identifiers.</p> </li> <li> <p> <code>UpdateEnvironment</code>: Changes the settings of an existing environment.</p> </li> <li> <p> <code>UpdateEnvironmentMembership</code>: Changes the settings of an existing environment member for an environment.</p> </li> </ul>"
|
||||
"documentation":"<fullname>AWS Cloud9</fullname> <p>AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.</p> <p>For more information about AWS Cloud9, see the <a href=\"https://docs.aws.amazon.com/cloud9/latest/user-guide\">AWS Cloud9 User Guide</a>.</p> <p>AWS Cloud9 supports these operations:</p> <ul> <li> <p> <code>CreateEnvironmentEC2</code>: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.</p> </li> <li> <p> <code>CreateEnvironmentMembership</code>: Adds an environment member to an environment.</p> </li> <li> <p> <code>DeleteEnvironment</code>: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.</p> </li> <li> <p> <code>DeleteEnvironmentMembership</code>: Deletes an environment member from an environment.</p> </li> <li> <p> <code>DescribeEnvironmentMemberships</code>: Gets information about environment members for an environment.</p> </li> <li> <p> <code>DescribeEnvironments</code>: Gets information about environments.</p> </li> <li> <p> <code>DescribeEnvironmentStatus</code>: Gets status information for an environment.</p> </li> <li> <p> <code>ListEnvironments</code>: Gets a list of environment identifiers.</p> </li> <li> <p> <code>ListTagsForResource</code>: Gets the tags for an environment.</p> </li> <li> <p> <code>TagResource</code>: Adds tags to an environment.</p> </li> <li> <p> <code>UntagResource</code>: Removes tags from an environment.</p> </li> <li> <p> <code>UpdateEnvironment</code>: Changes the settings of an existing environment.</p> </li> <li> <p> <code>UpdateEnvironmentMembership</code>: Changes the settings of an existing environment member for an environment.</p> </li> </ul>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -95,7 +95,7 @@
|
|||
{"shape":"InvalidOperationException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. <code>Accounts</code> and <code>Regions</code> are required parameters—you must specify at least one account and one region. </p>"
|
||||
"documentation":"<p>Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. You must specify at least one value for either <code>Accounts</code> or <code>DeploymentTargets</code>, and you must specify at least one value for <code>Regions</code>.</p>"
|
||||
},
|
||||
"CreateStackSet":{
|
||||
"name":"CreateStackSet",
|
||||
|
|
@ -652,7 +652,7 @@
|
|||
"errors":[
|
||||
{"shape":"CFNRegistryException"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of registration tokens for the specified type.</p>",
|
||||
"documentation":"<p>Returns a list of registration tokens for the specified type(s).</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"ListTypeVersions":{
|
||||
|
|
@ -721,7 +721,7 @@
|
|||
"errors":[
|
||||
{"shape":"CFNRegistryException"}
|
||||
],
|
||||
"documentation":"<p>Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes:</p> <ul> <li> <p>Validating the resource schema</p> </li> <li> <p>Determining which handlers have been specified for the resource</p> </li> <li> <p>Making the resource type available for use in your account</p> </li> </ul> <p>For more information on how to develop types and ready them for registeration, see <a href=\"cloudformation-cli/latest/userguide/resource-types.html\">Creating Resource Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p> <p>Once you have initiated a registration request using <code> <a>RegisterType</a> </code>, you can use <code> <a>DescribeTypeRegistration</a> </code> to monitor the progress of the registration request.</p>",
|
||||
"documentation":"<p>Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes:</p> <ul> <li> <p>Validating the resource schema</p> </li> <li> <p>Determining which handlers have been specified for the resource</p> </li> <li> <p>Making the resource type available for use in your account</p> </li> </ul> <p>For more information on how to develop types and ready them for registeration, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html\">Creating Resource Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p> <p>Once you have initiated a registration request using <code> <a>RegisterType</a> </code>, you can use <code> <a>DescribeTypeRegistration</a> </code> to monitor the progress of the registration request.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"SetStackPolicy":{
|
||||
|
|
@ -867,7 +867,7 @@
|
|||
"shapes":{
|
||||
"Account":{
|
||||
"type":"string",
|
||||
"pattern":"[0-9]{12}"
|
||||
"pattern":"^[0-9]{12}$"
|
||||
},
|
||||
"AccountGateResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -932,6 +932,21 @@
|
|||
"exception":true
|
||||
},
|
||||
"Arn":{"type":"string"},
|
||||
"AutoDeployment":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"AutoDeploymentNullable",
|
||||
"documentation":"<p>If set to <code>true</code>, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.</p>"
|
||||
},
|
||||
"RetainStacksOnAccountRemoval":{
|
||||
"shape":"RetainStacksOnAccountRemovalNullable",
|
||||
"documentation":"<p>If set to <code>true</code>, stack resources are retained when an account is removed from a target organization or OU. If set to <code>false</code>, stack resources are deleted. Specify only if <code>Enabled</code> is set to <code>True</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).</p>"
|
||||
},
|
||||
"AutoDeploymentNullable":{"type":"boolean"},
|
||||
"BoxedInteger":{
|
||||
"type":"integer",
|
||||
"box":true
|
||||
|
|
@ -1326,7 +1341,6 @@
|
|||
"type":"structure",
|
||||
"required":[
|
||||
"StackSetName",
|
||||
"Accounts",
|
||||
"Regions"
|
||||
],
|
||||
"members":{
|
||||
|
|
@ -1336,7 +1350,11 @@
|
|||
},
|
||||
"Accounts":{
|
||||
"shape":"AccountList",
|
||||
"documentation":"<p>The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.</p>"
|
||||
"documentation":"<p>[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
|
||||
},
|
||||
"DeploymentTargets":{
|
||||
"shape":"DeploymentTargets",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
|
||||
},
|
||||
"Regions":{
|
||||
"shape":"RegionList",
|
||||
|
|
@ -1416,6 +1434,14 @@
|
|||
"shape":"ExecutionRoleName",
|
||||
"documentation":"<p>The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set operation.</p> <p>Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. </p>"
|
||||
},
|
||||
"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 AWS 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>"
|
||||
},
|
||||
"AutoDeployment":{
|
||||
"shape":"AutoDeployment",
|
||||
"documentation":"<p>Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if <code>PermissionModel</code> is <code>SERVICE_MANAGED</code>.</p> <p>If you specify <code>AutoDeployment</code>, do not specify <code>DeploymentTargets</code> or <code>Regions</code>.</p>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>A unique identifier for this <code>CreateStackSet</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry <code>CreateStackSet</code> requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, the SDK generates one automatically. </p>",
|
||||
|
|
@ -1493,7 +1519,6 @@
|
|||
"type":"structure",
|
||||
"required":[
|
||||
"StackSetName",
|
||||
"Accounts",
|
||||
"Regions",
|
||||
"RetainStacks"
|
||||
],
|
||||
|
|
@ -1504,7 +1529,11 @@
|
|||
},
|
||||
"Accounts":{
|
||||
"shape":"AccountList",
|
||||
"documentation":"<p>The names of the AWS accounts that you want to delete stack instances for.</p>"
|
||||
"documentation":"<p>[Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
|
||||
},
|
||||
"DeploymentTargets":{
|
||||
"shape":"DeploymentTargets",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts from which to delete stack instances.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
|
||||
},
|
||||
"Regions":{
|
||||
"shape":"RegionList",
|
||||
|
|
@ -1550,6 +1579,20 @@
|
|||
}
|
||||
},
|
||||
"DeletionTime":{"type":"timestamp"},
|
||||
"DeploymentTargets":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Accounts":{
|
||||
"shape":"AccountList",
|
||||
"documentation":"<p>The names of one or more AWS accounts for which you want to deploy stack set updates.</p>"
|
||||
},
|
||||
"OrganizationalUnitIds":{
|
||||
"shape":"OrganizationalUnitIdList",
|
||||
"documentation":"<p>The organization root ID or organizational unit (OUs) IDs to which StackSets deploys.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts to which StackSets deploys.</p> <p>For update operations, you can specify either <code>Accounts</code> or <code>OrganizationalUnitIds</code>. For create and delete operations, specify <code>OrganizationalUnitIds</code>.</p>"
|
||||
},
|
||||
"DeprecatedStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -1562,15 +1605,15 @@
|
|||
"members":{
|
||||
"Arn":{
|
||||
"shape":"PrivateTypeArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the type.</p> <p>Conditional: You must specify <code>TypeName</code> or <code>Arn</code>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"RegistryType",
|
||||
"documentation":"<p>The kind of type.</p> <p>Currently the only valid value is <code>RESOURCE</code>.</p>"
|
||||
"documentation":"<p>The kind of type.</p> <p>Currently the only valid value is <code>RESOURCE</code>.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"TypeName":{
|
||||
"shape":"TypeName",
|
||||
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify <code>TypeName</code> or <code>Arn</code>.</p>"
|
||||
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"VersionId":{
|
||||
"shape":"TypeVersionId",
|
||||
|
|
@ -1974,15 +2017,15 @@
|
|||
"members":{
|
||||
"Type":{
|
||||
"shape":"RegistryType",
|
||||
"documentation":"<p>The kind of type. </p> <p>Currently the only valid value is <code>RESOURCE</code>.</p>"
|
||||
"documentation":"<p>The kind of type. </p> <p>Currently the only valid value is <code>RESOURCE</code>.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"TypeName":{
|
||||
"shape":"TypeName",
|
||||
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify <code>TypeName</code> or <code>Arn</code>.</p>"
|
||||
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"Arn":{
|
||||
"shape":"TypeArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the type.</p> <p>Conditional: You must specify <code>TypeName</code> or <code>Arn</code>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"VersionId":{
|
||||
"shape":"TypeVersionId",
|
||||
|
|
@ -2791,19 +2834,19 @@
|
|||
"members":{
|
||||
"Type":{
|
||||
"shape":"RegistryType",
|
||||
"documentation":"<p>The kind of type.</p> <p>Currently the only valid value is <code>RESOURCE</code>.</p>"
|
||||
"documentation":"<p>The kind of type.</p> <p>Currently the only valid value is <code>RESOURCE</code>.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"TypeName":{
|
||||
"shape":"TypeName",
|
||||
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify <code>TypeName</code> or <code>Arn</code>.</p>"
|
||||
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"TypeArn":{
|
||||
"shape":"TypeArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the type.</p> <p>Conditional: You must specify <code>TypeName</code> or <code>Arn</code>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"RegistrationStatusFilter":{
|
||||
"shape":"RegistrationStatus",
|
||||
"documentation":"<p>The current status of the type registration request.</p>"
|
||||
"documentation":"<p>The current status of the type registration request.</p> <p>The default is <code>IN_PROGRESS</code>.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -2833,15 +2876,15 @@
|
|||
"members":{
|
||||
"Type":{
|
||||
"shape":"RegistryType",
|
||||
"documentation":"<p>The kind of the type.</p> <p>Currently the only valid value is <code>RESOURCE</code>.</p>"
|
||||
"documentation":"<p>The kind of the type.</p> <p>Currently the only valid value is <code>RESOURCE</code>.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"TypeName":{
|
||||
"shape":"TypeName",
|
||||
"documentation":"<p>The name of the type for which you want version summary information.</p> <p>Conditional: You must specify <code>TypeName</code> or <code>Arn</code>.</p>"
|
||||
"documentation":"<p>The name of the type for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"Arn":{
|
||||
"shape":"PrivateTypeArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the type for which you want version summary information.</p> <p>Conditional: You must specify <code>TypeName</code> or <code>Arn</code>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the type for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -2853,7 +2896,7 @@
|
|||
},
|
||||
"DeprecatedStatus":{
|
||||
"shape":"DeprecatedStatus",
|
||||
"documentation":"<p>The deprecation status of the type versions that you want to get summary information about.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The type version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.</p> </li> <li> <p> <code>DEPRECATED</code>: The type version has been deregistered and can no longer be used in CloudFormation operations. </p> </li> </ul>"
|
||||
"documentation":"<p>The deprecation status of the type versions that you want to get summary information about.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The type version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.</p> </li> <li> <p> <code>DEPRECATED</code>: The type version has been deregistered and can no longer be used in CloudFormation operations. </p> </li> </ul> <p>The default is <code>LIVE</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2875,7 +2918,7 @@
|
|||
"members":{
|
||||
"Visibility":{
|
||||
"shape":"Visibility",
|
||||
"documentation":"<p>The scope at which the type is visible and usable in CloudFormation operations.</p> <p>Valid values include:</p> <ul> <li> <p> <code>PRIVATE</code>: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as <code>PRIVATE</code>.</p> </li> <li> <p> <code>PUBLIC</code>: The type is publically visible and usable within any Amazon account.</p> </li> </ul>"
|
||||
"documentation":"<p>The scope at which the type is visible and usable in CloudFormation operations.</p> <p>Valid values include:</p> <ul> <li> <p> <code>PRIVATE</code>: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as <code>PRIVATE</code>.</p> </li> <li> <p> <code>PUBLIC</code>: The type is publically visible and usable within any Amazon account.</p> </li> </ul> <p>The default is <code>PRIVATE</code>.</p>"
|
||||
},
|
||||
"ProvisioningType":{
|
||||
"shape":"ProvisioningType",
|
||||
|
|
@ -3052,6 +3095,14 @@
|
|||
"type":"string",
|
||||
"max":4096
|
||||
},
|
||||
"OrganizationalUnitId":{
|
||||
"type":"string",
|
||||
"pattern":"^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$"
|
||||
},
|
||||
"OrganizationalUnitIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"OrganizationalUnitId"}
|
||||
},
|
||||
"Output":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3153,6 +3204,13 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Parameter"}
|
||||
},
|
||||
"PermissionModels":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SERVICE_MANAGED",
|
||||
"SELF_MANAGED"
|
||||
]
|
||||
},
|
||||
"PhysicalResourceId":{"type":"string"},
|
||||
"PhysicalResourceIdContext":{
|
||||
"type":"list",
|
||||
|
|
@ -3269,7 +3327,10 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"Region":{"type":"string"},
|
||||
"Region":{
|
||||
"type":"string",
|
||||
"pattern":"^[a-zA-Z0-9-]{1,128}$"
|
||||
},
|
||||
"RegionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Region"}
|
||||
|
|
@ -3291,7 +3352,7 @@
|
|||
},
|
||||
"SchemaHandlerPackage":{
|
||||
"shape":"S3Url",
|
||||
"documentation":"<p>A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.</p> <p>For information on generating a schema handler package for the type you want to register, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html\">submit</a> in the <i>CloudFormation CLI User Guide</i>.</p>"
|
||||
"documentation":"<p>A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.</p> <p>For information on generating a schema handler package for the type you want to register, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html\">submit</a> in the <i>CloudFormation CLI User Guide</i>.</p> <note> <p>As part of registering a resource provider type, CloudFormation must be able to access the S3 bucket which contains the schema handler package for that resource provider. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-register-permissions\">IAM Permissions for Registering a Resource Provider</a> in the <i>AWS CloudFormation User Guide</i>.</p> </note>"
|
||||
},
|
||||
"LoggingConfig":{
|
||||
"shape":"LoggingConfig",
|
||||
|
|
@ -3583,6 +3644,7 @@
|
|||
},
|
||||
"RetainStacks":{"type":"boolean"},
|
||||
"RetainStacksNullable":{"type":"boolean"},
|
||||
"RetainStacksOnAccountRemovalNullable":{"type":"boolean"},
|
||||
"RoleARN":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
|
|
@ -3664,15 +3726,15 @@
|
|||
"members":{
|
||||
"Arn":{
|
||||
"shape":"PrivateTypeArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the type for which you want version summary information.</p> <p>Conditional: You must specify <code>TypeName</code> or <code>Arn</code>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the type for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"RegistryType",
|
||||
"documentation":"<p>The kind of type.</p>"
|
||||
"documentation":"<p>The kind of type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"TypeName":{
|
||||
"shape":"TypeName",
|
||||
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify <code>TypeName</code> or <code>Arn</code>.</p>"
|
||||
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
|
||||
},
|
||||
"VersionId":{
|
||||
"shape":"TypeVersionId",
|
||||
|
|
@ -3939,7 +4001,7 @@
|
|||
},
|
||||
"Account":{
|
||||
"shape":"Account",
|
||||
"documentation":"<p>The name of the AWS account that the stack instance is associated with.</p>"
|
||||
"documentation":"<p>[Self-managed permissions] The name of the AWS account that the stack instance is associated with.</p>"
|
||||
},
|
||||
"StackId":{
|
||||
"shape":"StackId",
|
||||
|
|
@ -3957,6 +4019,10 @@
|
|||
"shape":"Reason",
|
||||
"documentation":"<p>The explanation for the specific status code that is assigned to this stack instance.</p>"
|
||||
},
|
||||
"OrganizationalUnitId":{
|
||||
"shape":"OrganizationalUnitId",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) ID that the stack instance is associated with.</p>"
|
||||
},
|
||||
"DriftStatus":{
|
||||
"shape":"StackDriftStatus",
|
||||
"documentation":"<p>Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. </p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: AWS CloudFormation has not checked if the stack instance differs from its expected stack set configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack instance's actual configuration matches its expected stack set configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: This value is reserved for future use.</p> </li> </ul>"
|
||||
|
|
@ -4005,7 +4071,7 @@
|
|||
},
|
||||
"Account":{
|
||||
"shape":"Account",
|
||||
"documentation":"<p>The name of the AWS account that the stack instance is associated with.</p>"
|
||||
"documentation":"<p>[Self-managed permissions] The name of the AWS account that the stack instance is associated with.</p>"
|
||||
},
|
||||
"StackId":{
|
||||
"shape":"StackId",
|
||||
|
|
@ -4019,6 +4085,10 @@
|
|||
"shape":"Reason",
|
||||
"documentation":"<p>The explanation for the specific status code assigned to this stack instance.</p>"
|
||||
},
|
||||
"OrganizationalUnitId":{
|
||||
"shape":"OrganizationalUnitId",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) ID that the stack instance is associated with.</p>"
|
||||
},
|
||||
"DriftStatus":{
|
||||
"shape":"StackDriftStatus",
|
||||
"documentation":"<p>Status of the stack instance's actual configuration compared to the expected template and parameter configuration of the stack set to which it belongs. </p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from the expected template and parameter configuration of the stack set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: AWS CloudFormation has not checked if the stack instance differs from its expected stack set configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack instance's actual configuration matches its expected stack set configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: This value is reserved for future use.</p> </li> </ul>"
|
||||
|
|
@ -4364,6 +4434,18 @@
|
|||
"StackSetDriftDetectionDetails":{
|
||||
"shape":"StackSetDriftDetectionDetails",
|
||||
"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 currently in progress is not included.</p>"
|
||||
},
|
||||
"AutoDeployment":{
|
||||
"shape":"AutoDeployment",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).</p>"
|
||||
},
|
||||
"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 AWS 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>"
|
||||
},
|
||||
"OrganizationalUnitIds":{
|
||||
"shape":"OrganizationalUnitIdList",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OUs) IDs to which stacks in your stack set have been deployed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires. </p>"
|
||||
|
|
@ -4472,7 +4554,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"StackSetOperationStatus",
|
||||
"documentation":"<p>The status of the operation. </p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining regions.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
|
||||
"documentation":"<p>The status of the operation. </p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining regions.</p> </li> <li> <p> <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of operations. The operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes\">stack set operation status codes</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
|
||||
},
|
||||
"OperationPreferences":{
|
||||
"shape":"StackSetOperationPreferences",
|
||||
|
|
@ -4498,6 +4580,10 @@
|
|||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.</p>"
|
||||
},
|
||||
"DeploymentTargets":{
|
||||
"shape":"DeploymentTargets",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts affected by the stack operation.</p>"
|
||||
},
|
||||
"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\">Detecting Unmanaged Changes in Stack Sets</a> in the AWS CloudFormation User Guide.</p>"
|
||||
|
|
@ -4559,7 +4645,7 @@
|
|||
"members":{
|
||||
"Account":{
|
||||
"shape":"Account",
|
||||
"documentation":"<p>The name of the AWS account for this operation result.</p>"
|
||||
"documentation":"<p>[Self-managed permissions] The name of the AWS account for this operation result.</p>"
|
||||
},
|
||||
"Region":{
|
||||
"shape":"Region",
|
||||
|
|
@ -4576,6 +4662,10 @@
|
|||
"AccountGateResult":{
|
||||
"shape":"AccountGateResult",
|
||||
"documentation":"<p>The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account</p>"
|
||||
},
|
||||
"OrganizationalUnitId":{
|
||||
"shape":"OrganizationalUnitId",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) ID for this operation result.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure that contains information about a specified operation's results for a given account in a given region.</p>"
|
||||
|
|
@ -4587,7 +4677,8 @@
|
|||
"SUCCEEDED",
|
||||
"FAILED",
|
||||
"STOPPING",
|
||||
"STOPPED"
|
||||
"STOPPED",
|
||||
"QUEUED"
|
||||
]
|
||||
},
|
||||
"StackSetOperationSummaries":{
|
||||
|
|
@ -4607,7 +4698,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"StackSetOperationStatus",
|
||||
"documentation":"<p>The overall status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining regions.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
|
||||
"documentation":"<p>The overall status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining regions.</p> </li> <li> <p> <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of operations. The operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes\">stack set operation status codes</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
|
||||
},
|
||||
"CreationTimestamp":{
|
||||
"shape":"Timestamp",
|
||||
|
|
@ -4650,6 +4741,14 @@
|
|||
"shape":"StackSetStatus",
|
||||
"documentation":"<p>The status of the stack set.</p>"
|
||||
},
|
||||
"AutoDeployment":{
|
||||
"shape":"AutoDeployment",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organizational unit (OU).</p>"
|
||||
},
|
||||
"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 AWS 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>"
|
||||
},
|
||||
"DriftStatus":{
|
||||
"shape":"StackDriftStatus",
|
||||
"documentation":"<p>Status of the stack set's actual configuration compared to its expected template and parameter configuration. A stack set is considered to have drifted if one or more of its stack instances have drifted from their expected template and parameter configuration.</p> <ul> <li> <p> <code>DRIFTED</code>: One or more of the stack instances belonging to the stack set stack differs from the expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the resources in the associated stack have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: AWS CloudFormation has not checked the stack set for drift.</p> </li> <li> <p> <code>IN_SYNC</code>: All of the stack instances belonging to the stack set stack match from the expected template and parameter configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: This value is reserved for future use.</p> </li> </ul>"
|
||||
|
|
@ -5078,7 +5177,6 @@
|
|||
"type":"structure",
|
||||
"required":[
|
||||
"StackSetName",
|
||||
"Accounts",
|
||||
"Regions"
|
||||
],
|
||||
"members":{
|
||||
|
|
@ -5088,7 +5186,11 @@
|
|||
},
|
||||
"Accounts":{
|
||||
"shape":"AccountList",
|
||||
"documentation":"<p>The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p>"
|
||||
"documentation":"<p>[Self-managed permissions] The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
|
||||
},
|
||||
"DeploymentTargets":{
|
||||
"shape":"DeploymentTargets",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
|
||||
},
|
||||
"Regions":{
|
||||
"shape":"RegionList",
|
||||
|
|
@ -5176,6 +5278,18 @@
|
|||
"shape":"ExecutionRoleName",
|
||||
"documentation":"<p>The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set operation.</p> <p>Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. </p> <p> If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.</p>"
|
||||
},
|
||||
"DeploymentTargets":{
|
||||
"shape":"DeploymentTargets",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts in which to update associated stack instances.</p> <p>To update all the stack instances associated with this stack set, do not specify <code>DeploymentTargets</code> or <code>Regions</code>.</p> <p>If the stack set update includes changes to the template (that is, if <code>TemplateBody</code> or <code>TemplateURL</code> is specified), or the <code>Parameters</code>, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.</p>"
|
||||
},
|
||||
"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 AWS 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>"
|
||||
},
|
||||
"AutoDeployment":{
|
||||
"shape":"AutoDeployment",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).</p> <p>If you specify <code>AutoDeployment</code>, do not specify <code>DeploymentTargets</code> or <code>Regions</code>.</p>"
|
||||
},
|
||||
"OperationId":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>The unique ID for this stack set operation. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, AWS CloudFormation generates one automatically.</p> <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>. </p>",
|
||||
|
|
@ -5183,7 +5297,7 @@
|
|||
},
|
||||
"Accounts":{
|
||||
"shape":"AccountList",
|
||||
"documentation":"<p>The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status. </p>"
|
||||
"documentation":"<p>[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status. </p>"
|
||||
},
|
||||
"Regions":{
|
||||
"shape":"RegionList",
|
||||
|
|
|
|||
|
|
@ -10,7 +10,10 @@
|
|||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "MetricAlarms"
|
||||
"result_key": [
|
||||
"MetricAlarms",
|
||||
"CompositeAlarms"
|
||||
]
|
||||
},
|
||||
"ListDashboards": {
|
||||
"input_token": "NextToken",
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceNotFound"}
|
||||
],
|
||||
"documentation":"<p>Deletes the specified alarms. You can delete up to 50 alarms in one operation. In the event of an error, no alarms are deleted.</p>"
|
||||
"documentation":"<p>Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.</p> <p> In the event of an error, no alarms are deleted.</p> <note> <p>It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.</p> <p>To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the <code>AlarmRule</code> of one of the alarms to <code>False</code>. </p> <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. </p> </note>"
|
||||
},
|
||||
"DeleteAnomalyDetector":{
|
||||
"name":"DeleteAnomalyDetector",
|
||||
|
|
@ -92,7 +92,7 @@
|
|||
"errors":[
|
||||
{"shape":"InvalidNextToken"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for all alarms are returned.</p> <p>CloudWatch retains the history of an alarm even if you delete the alarm.</p>"
|
||||
"documentation":"<p>Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.</p> <p>CloudWatch retains the history of an alarm even if you delete the alarm.</p>"
|
||||
},
|
||||
"DescribeAlarms":{
|
||||
"name":"DescribeAlarms",
|
||||
|
|
@ -108,7 +108,7 @@
|
|||
"errors":[
|
||||
{"shape":"InvalidNextToken"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.</p>"
|
||||
"documentation":"<p>Retrieves the specified alarms. You can filter the results by specifying a a prefix for the alarm name, the alarm state, or a prefix for any action.</p>"
|
||||
},
|
||||
"DescribeAlarmsForMetric":{
|
||||
"name":"DescribeAlarmsForMetric",
|
||||
|
|
@ -260,7 +260,7 @@
|
|||
"errors":[
|
||||
{"shape":"InvalidNextToken"}
|
||||
],
|
||||
"documentation":"<p>You can use the <code>GetMetricData</code> API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than calls to <code>GetMetricStatistics</code>. For more information about pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p> <p>If you omit <code>Unit</code> in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>"
|
||||
"documentation":"<p>You can use the <code>GetMetricData</code> API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than calls to <code>GetMetricStatistics</code>. For more information about pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p> <p>If you omit <code>Unit</code> in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>"
|
||||
},
|
||||
"GetMetricStatistics":{
|
||||
"name":"GetMetricStatistics",
|
||||
|
|
@ -326,7 +326,7 @@
|
|||
{"shape":"InternalServiceFault"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>List the specified metrics. You can use the returned metrics with <a>GetMetricData</a> or <a>GetMetricStatistics</a> to obtain statistical data.</p> <p>Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.</p> <p>After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using <a>GetMetricData</a> or <a>GetMetricStatistics</a>.</p>"
|
||||
"documentation":"<p>List the specified metrics. You can use the returned metrics with <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html\">GetMetricData</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html\">GetMetricStatistics</a> to obtain statistical data.</p> <p>Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.</p> <p>After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html\">GetMetricData</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html\">GetMetricStatistics</a>.</p>"
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
|
|
@ -365,6 +365,18 @@
|
|||
],
|
||||
"documentation":"<p>Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html\">CloudWatch Anomaly Detection</a>.</p>"
|
||||
},
|
||||
"PutCompositeAlarm":{
|
||||
"name":"PutCompositeAlarm",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"PutCompositeAlarmInput"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededFault"}
|
||||
],
|
||||
"documentation":"<p>Creates or updates a <i>composite alarm</i>. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.</p> <p>The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.</p> <p>Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.</p> <p>Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.</p> <note> <p>It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.</p> <p>To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the <code>AlarmRule</code> of one of the alarms to <code>False</code>. </p> <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path. </p> </note> <p>When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in <code>INSUFFICIENT_DATA</code> state.</p> <p>When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.</p>"
|
||||
},
|
||||
"PutDashboard":{
|
||||
"name":"PutDashboard",
|
||||
"http":{
|
||||
|
|
@ -425,7 +437,7 @@
|
|||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"InternalServiceFault"}
|
||||
],
|
||||
"documentation":"<p>Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to <a>ListMetrics</a>.</p> <p>You can publish either individual data points in the <code>Value</code> field, or arrays of values and the number of times each value occurred during the period by using the <code>Values</code> and <code>Counts</code> fields in the <code>MetricDatum</code> structure. Using the <code>Values</code> and <code>Counts</code> method enables you to publish up to 150 values per metric with one <code>PutMetricData</code> request, and supports retrieving percentile statistics on this data.</p> <p>Each <code>PutMetricData</code> request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.</p> <p>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.</p> <p>You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publishing Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for <a>GetMetricData</a> or <a>GetMetricStatistics</a> from the time they are submitted.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The <code>SampleCount</code> value of the statistic set is 1 and <code>Min</code>, <code>Max</code>, and <code>Sum</code> are all equal.</p> </li> <li> <p>The <code>Min</code> and <code>Max</code> are equal, and <code>Sum</code> is equal to <code>Min</code> multiplied by <code>SampleCount</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html\">ListMetrics</a>.</p> <p>You can publish either individual data points in the <code>Value</code> field, or arrays of values and the number of times each value occurred during the period by using the <code>Values</code> and <code>Counts</code> fields in the <code>MetricDatum</code> structure. Using the <code>Values</code> and <code>Counts</code> method enables you to publish up to 150 values per metric with one <code>PutMetricData</code> request, and supports retrieving percentile statistics on this data.</p> <p>Each <code>PutMetricData</code> request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.</p> <p>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.</p> <p>You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publishing Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html\">GetMetricData</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html\">GetMetricStatistics</a> from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html\">GetMetricData</a> or <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html\">GetMetricStatistics</a>.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The <code>SampleCount</code> value of the statistic set is 1 and <code>Min</code>, <code>Max</code>, and <code>Sum</code> are all equal.</p> </li> <li> <p>The <code>Min</code> and <code>Max</code> are equal, and <code>Sum</code> is equal to <code>Min</code> multiplied by <code>SampleCount</code>.</p> </li> </ul>"
|
||||
},
|
||||
"SetAlarmState":{
|
||||
"name":"SetAlarmState",
|
||||
|
|
@ -438,7 +450,7 @@
|
|||
{"shape":"ResourceNotFound"},
|
||||
{"shape":"InvalidFormatFault"}
|
||||
],
|
||||
"documentation":"<p>Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to <code>ALARM</code> sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through <a>DescribeAlarmHistory</a>.</p>"
|
||||
"documentation":"<p>Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to <code>ALARM</code> sends an SNS message.</p> <p>Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarmHistory.html\">DescribeAlarmHistory</a>.</p> <p>If you use <code>SetAlarmState</code> on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It will return to its actual state only once any of its children alarms change state. It is also re-evaluated if you update its configuration.</p> <p>If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the <code>StateReasonData</code> parameter to enable the policy to take the correct action.</p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
|
|
@ -503,6 +515,10 @@
|
|||
"shape":"AlarmName",
|
||||
"documentation":"<p>The descriptive name for the alarm.</p>"
|
||||
},
|
||||
"AlarmType":{
|
||||
"shape":"AlarmType",
|
||||
"documentation":"<p>The type of alarm, either metric alarm or composite alarm.</p>"
|
||||
},
|
||||
"Timestamp":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time stamp for the alarm history item.</p>"
|
||||
|
|
@ -541,6 +557,22 @@
|
|||
"member":{"shape":"AlarmName"},
|
||||
"max":100
|
||||
},
|
||||
"AlarmRule":{
|
||||
"type":"string",
|
||||
"max":10240,
|
||||
"min":1
|
||||
},
|
||||
"AlarmType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CompositeAlarm",
|
||||
"MetricAlarm"
|
||||
]
|
||||
},
|
||||
"AlarmTypes":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AlarmType"}
|
||||
},
|
||||
"AmazonResourceName":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
|
|
@ -624,6 +656,83 @@
|
|||
"GreaterThanUpperThreshold"
|
||||
]
|
||||
},
|
||||
"CompositeAlarm":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ActionsEnabled":{
|
||||
"shape":"ActionsEnabled",
|
||||
"documentation":"<p>Indicates whether actions should be executed during any changes to the alarm state.</p>"
|
||||
},
|
||||
"AlarmActions":{
|
||||
"shape":"ResourceList",
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>"
|
||||
},
|
||||
"AlarmArn":{
|
||||
"shape":"AlarmArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the alarm.</p>"
|
||||
},
|
||||
"AlarmConfigurationUpdatedTimestamp":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time stamp of the last update to the alarm configuration.</p>"
|
||||
},
|
||||
"AlarmDescription":{
|
||||
"shape":"AlarmDescription",
|
||||
"documentation":"<p>The description of the alarm.</p>"
|
||||
},
|
||||
"AlarmName":{
|
||||
"shape":"AlarmName",
|
||||
"documentation":"<p>The name of the alarm.</p>"
|
||||
},
|
||||
"AlarmRule":{
|
||||
"shape":"AlarmRule",
|
||||
"documentation":"<p>The rule that this alarm uses to evaluate its alarm state.</p>"
|
||||
},
|
||||
"InsufficientDataActions":{
|
||||
"shape":"ResourceList",
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>"
|
||||
},
|
||||
"OKActions":{
|
||||
"shape":"ResourceList",
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>"
|
||||
},
|
||||
"StateReason":{
|
||||
"shape":"StateReason",
|
||||
"documentation":"<p>An explanation for the alarm state, in text format.</p>"
|
||||
},
|
||||
"StateReasonData":{
|
||||
"shape":"StateReasonData",
|
||||
"documentation":"<p>An explanation for the alarm state, in JSON format.</p>"
|
||||
},
|
||||
"StateUpdatedTimestamp":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time stamp of the last update to the alarm state.</p>"
|
||||
},
|
||||
"StateValue":{
|
||||
"shape":"StateValue",
|
||||
"documentation":"<p>The state value for the alarm.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The details about a composite alarm.</p>",
|
||||
"xmlOrder":[
|
||||
"ActionsEnabled",
|
||||
"AlarmActions",
|
||||
"AlarmArn",
|
||||
"AlarmConfigurationUpdatedTimestamp",
|
||||
"AlarmDescription",
|
||||
"AlarmName",
|
||||
"AlarmRule",
|
||||
"InsufficientDataActions",
|
||||
"OKActions",
|
||||
"StateReason",
|
||||
"StateReasonData",
|
||||
"StateUpdatedTimestamp",
|
||||
"StateValue"
|
||||
]
|
||||
},
|
||||
"CompositeAlarms":{
|
||||
"type":"list",
|
||||
"member":{"shape":"CompositeAlarm"}
|
||||
},
|
||||
"ConcurrentModificationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -849,7 +958,7 @@
|
|||
"members":{
|
||||
"RuleNames":{
|
||||
"shape":"InsightRuleNames",
|
||||
"documentation":"<p>An array of the rule names to delete. If you need to find out the names of your rules, use <a>DescribeInsightRules</a>.</p>"
|
||||
"documentation":"<p>An array of the rule names to delete. If you need to find out the names of your rules, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html\">DescribeInsightRules</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -869,6 +978,10 @@
|
|||
"shape":"AlarmName",
|
||||
"documentation":"<p>The name of the alarm.</p>"
|
||||
},
|
||||
"AlarmTypes":{
|
||||
"shape":"AlarmTypes",
|
||||
"documentation":"<p>Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.</p>"
|
||||
},
|
||||
"HistoryItemType":{
|
||||
"shape":"HistoryItemType",
|
||||
"documentation":"<p>The type of alarm histories to retrieve.</p>"
|
||||
|
|
@ -888,6 +1001,10 @@
|
|||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token returned by a previous call to indicate that there is more data available.</p>"
|
||||
},
|
||||
"ScanBy":{
|
||||
"shape":"ScanBy",
|
||||
"documentation":"<p>Specified whether to return the newest or oldest alarm history first. Specify <code>TimestampDescending</code> to have the newest event history returned first, and specify <code>TimestampAscending</code> to have the oldest history returned first.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -955,19 +1072,31 @@
|
|||
"members":{
|
||||
"AlarmNames":{
|
||||
"shape":"AlarmNames",
|
||||
"documentation":"<p>The names of the alarms.</p>"
|
||||
"documentation":"<p>The names of the alarms to retrieve information about.</p>"
|
||||
},
|
||||
"AlarmNamePrefix":{
|
||||
"shape":"AlarmNamePrefix",
|
||||
"documentation":"<p>The alarm name prefix. If this parameter is specified, you cannot specify <code>AlarmNames</code>.</p>"
|
||||
"documentation":"<p>An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.</p> <p>If this parameter is specified, you cannot specify <code>AlarmNames</code>.</p>"
|
||||
},
|
||||
"AlarmTypes":{
|
||||
"shape":"AlarmTypes",
|
||||
"documentation":"<p>Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.</p>"
|
||||
},
|
||||
"ChildrenOfAlarmName":{
|
||||
"shape":"AlarmName",
|
||||
"documentation":"<p>If you use this parameter and specify the name of a composite alarm, the operation returns information about the \"children\" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the <code>AlarmRule</code> field of the composite alarm that you specify in <code>ChildrenOfAlarmName</code>. Information about the composite alarm that you name in <code>ChildrenOfAlarmName</code> is not returned.</p> <p>If you specify <code>ChildrenOfAlarmName</code>, you cannot specify any other parameters in the request except for <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you will receive a validation error.</p> <note> <p>Only the <code>Alarm Name</code>, <code>ARN</code>, <code>StateValue</code> (OK/ALARM/INSUFFICIENT_DATA), and <code>StateUpdatedTimestamp</code> information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another <code>DescribeAlarms</code> operation and specify the parent alarm names in the <code>AlarmNames</code> parameter.</p> </note>"
|
||||
},
|
||||
"ParentsOfAlarmName":{
|
||||
"shape":"AlarmName",
|
||||
"documentation":"<p>If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the \"parent\" alarms of the alarm you specify. These are the composite alarms that have <code>AlarmRule</code> parameters that reference the alarm named in <code>ParentsOfAlarmName</code>. Information about the alarm that you specify in <code>ParentsOfAlarmName</code> is not returned.</p> <p>If you specify <code>ParentsOfAlarmName</code>, you cannot specify any other parameters in the request except for <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you will receive a validation error.</p> <note> <p>Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another <code>DescribeAlarms</code> operation and specify the parent alarm names in the <code>AlarmNames</code> parameter.</p> </note>"
|
||||
},
|
||||
"StateValue":{
|
||||
"shape":"StateValue",
|
||||
"documentation":"<p>The state value to be used in matching alarms.</p>"
|
||||
"documentation":"<p>Specify this parameter to receive information only about alarms that are currently in the state that you specify.</p>"
|
||||
},
|
||||
"ActionPrefix":{
|
||||
"shape":"ActionPrefix",
|
||||
"documentation":"<p>The action name prefix.</p>"
|
||||
"documentation":"<p>Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.</p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
|
|
@ -982,9 +1111,13 @@
|
|||
"DescribeAlarmsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CompositeAlarms":{
|
||||
"shape":"CompositeAlarms",
|
||||
"documentation":"<p>The information about any composite alarms returned by the operation.</p>"
|
||||
},
|
||||
"MetricAlarms":{
|
||||
"shape":"MetricAlarms",
|
||||
"documentation":"<p>The information for the specified alarms.</p>"
|
||||
"documentation":"<p>The information about any metric alarms returned by the operation.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
|
|
@ -1001,7 +1134,7 @@
|
|||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxReturnedResultsCount",
|
||||
"documentation":"<p>The maximum number of results to return in one operation. The maximum value you can specify is 10.</p> <p>To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. </p>"
|
||||
"documentation":"<p>The maximum number of results to return in one operation. The maximum value that you can specify is 100.</p> <p>To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. </p>"
|
||||
},
|
||||
"Namespace":{
|
||||
"shape":"Namespace",
|
||||
|
|
@ -1129,7 +1262,7 @@
|
|||
"members":{
|
||||
"RuleNames":{
|
||||
"shape":"InsightRuleNames",
|
||||
"documentation":"<p>An array of the rule names to disable. If you need to find out the names of your rules, use <a>DescribeInsightRules</a>.</p>"
|
||||
"documentation":"<p>An array of the rule names to disable. If you need to find out the names of your rules, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html\">DescribeInsightRules</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1158,7 +1291,7 @@
|
|||
"members":{
|
||||
"RuleNames":{
|
||||
"shape":"InsightRuleNames",
|
||||
"documentation":"<p>An array of the rule names to enable. If you need to find out the names of your rules, use <a>DescribeInsightRules</a>.</p>"
|
||||
"documentation":"<p>An array of the rule names to enable. If you need to find out the names of your rules, use <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html\">DescribeInsightRules</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1219,7 +1352,7 @@
|
|||
},
|
||||
"DashboardBody":{
|
||||
"shape":"DashboardBody",
|
||||
"documentation":"<p>The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the <code>DashboardBody</code> syntax, see <a>CloudWatch-Dashboard-Body-Structure</a>. </p>"
|
||||
"documentation":"<p>The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the <code>DashboardBody</code> syntax, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html\">Dashboard Body Structure and Syntax</a>. </p>"
|
||||
},
|
||||
"DashboardName":{
|
||||
"shape":"DashboardName",
|
||||
|
|
@ -1305,7 +1438,7 @@
|
|||
"members":{
|
||||
"MetricDataQueries":{
|
||||
"shape":"MetricDataQueries",
|
||||
"documentation":"<p>The metric queries to be returned. A single <code>GetMetricData</code> call can include as many as 100 <code>MetricDataQuery</code> structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data. </p>"
|
||||
"documentation":"<p>The metric queries to be returned. A single <code>GetMetricData</code> call can include as many as 500 <code>MetricDataQuery</code> structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data. </p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"Timestamp",
|
||||
|
|
@ -1414,7 +1547,7 @@
|
|||
"members":{
|
||||
"MetricWidget":{
|
||||
"shape":"MetricWidget",
|
||||
"documentation":"<p>A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the graph, statistics, annotations, title, axis limits, and so on. You can include only one <code>MetricWidget</code> parameter in each <code>GetMetricWidgetImage</code> call.</p> <p>For more information about the syntax of <code>MetricWidget</code> see <a>CloudWatch-Metric-Widget-Structure</a>.</p> <p>If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend.</p>"
|
||||
"documentation":"<p>A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the graph, statistics, annotations, title, axis limits, and so on. You can include only one <code>MetricWidget</code> parameter in each <code>GetMetricWidgetImage</code> call.</p> <p>For more information about the syntax of <code>MetricWidget</code> see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html\">GetMetricWidgetImage: Metric Widget Structure and Syntax</a>.</p> <p>If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend.</p>"
|
||||
},
|
||||
"OutputFormat":{
|
||||
"shape":"OutputFormat",
|
||||
|
|
@ -1499,7 +1632,7 @@
|
|||
"documentation":"<p>An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.</p> <p>If the rule contains a single key, then each unique contributor is each unique value for this key.</p> <p>For more information, see <a>GetInsightRuleReport</a>.</p>"
|
||||
"documentation":"<p>One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.</p> <p>If the rule contains a single key, then each unique contributor is each unique value for this key.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html\">GetInsightRuleReport</a>.</p>"
|
||||
},
|
||||
"InsightRuleContributorDatapoint":{
|
||||
"type":"structure",
|
||||
|
|
@ -1517,7 +1650,7 @@
|
|||
"documentation":"<p>The approximate value that this contributor added during this timestamp.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>One data point related to one contributor.</p> <p>For more information, see <a>GetInsightRuleReport</a> and <a>InsightRuleContributor</a>.</p>"
|
||||
"documentation":"<p>One data point related to one contributor.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html\">GetInsightRuleReport</a> and <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html\">InsightRuleContributor</a>.</p>"
|
||||
},
|
||||
"InsightRuleContributorDatapoints":{
|
||||
"type":"list",
|
||||
|
|
@ -1585,7 +1718,7 @@
|
|||
"documentation":"<p>The maximum value from a single occurence from a single contributor during the time period represented by that data point.</p> <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>One data point from the metric time series returned in a Contributor Insights rule report.</p> <p>For more information, see <a>GetInsightRuleReport</a>.</p>"
|
||||
"documentation":"<p>One data point from the metric time series returned in a Contributor Insights rule report.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html\">GetInsightRuleReport</a>.</p>"
|
||||
},
|
||||
"InsightRuleMetricDatapoints":{
|
||||
"type":"list",
|
||||
|
|
@ -1986,7 +2119,7 @@
|
|||
"documentation":"<p>In an alarm based on an anomaly detection model, this is the ID of the <code>ANOMALY_DETECTION_BAND</code> function used as the threshold for the alarm.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents an alarm.</p>",
|
||||
"documentation":"<p>The details about a metric alarm.</p>",
|
||||
"xmlOrder":[
|
||||
"AlarmName",
|
||||
"AlarmArn",
|
||||
|
|
@ -2055,10 +2188,10 @@
|
|||
},
|
||||
"Period":{
|
||||
"shape":"Period",
|
||||
"documentation":"<p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a <code>PutMetricData</code> operation that includes a <code>StorageResolution of 1 second</code>.</p> <p>If you are performing a <code>GetMetricData</code> operation, use this field only if you are specifying an <code>Expression</code>. Do not use this field when you are specifying a <code>MetricStat</code> in a <code>GetMetricData</code> operation.</p>"
|
||||
"documentation":"<p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a <code>PutMetricData</code> operation that includes a <code>StorageResolution of 1 second</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This structure is used in both <code>GetMetricData</code> and <code>PutMetricAlarm</code>. The supported use of this structure is different for those two operations.</p> <p>When used in <code>GetMetricData</code>, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single <code>GetMetricData</code> call can include up to 100 <code>MetricDataQuery</code> structures.</p> <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a metric math expression. Each <code>MetricDataQuery</code> in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single <code>PutMetricAlarm</code> call can include up to 20 <code>MetricDataQuery</code> structures in the array. The 20 structures can include as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a metric, and as many as 10 structures that contain the <code>Expression</code> parameter to perform a math expression. Of those <code>Expression</code> structures, one must have <code>True</code> as the value for <code>ReturnData</code>. The result of this expression is the value the alarm watches.</p> <p>Any expression used in a <code>PutMetricAlarm</code> operation must return a single time series. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Some of the parameters of this structure also have different uses whether you are using this structure in a <code>GetMetricData</code> operation or a <code>PutMetricAlarm</code> operation. These differences are explained in the following parameter list.</p>"
|
||||
"documentation":"<p>This structure is used in both <code>GetMetricData</code> and <code>PutMetricAlarm</code>. The supported use of this structure is different for those two operations.</p> <p>When used in <code>GetMetricData</code>, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single <code>GetMetricData</code> call can include up to 500 <code>MetricDataQuery</code> structures.</p> <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a metric math expression. Each <code>MetricDataQuery</code> in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single <code>PutMetricAlarm</code> call can include up to 20 <code>MetricDataQuery</code> structures in the array. The 20 structures can include as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a metric, and as many as 10 structures that contain the <code>Expression</code> parameter to perform a math expression. Of those <code>Expression</code> structures, one must have <code>True</code> as the value for <code>ReturnData</code>. The result of this expression is the value the alarm watches.</p> <p>Any expression used in a <code>PutMetricAlarm</code> operation must return a single time series. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax\">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Some of the parameters of this structure also have different uses whether you are using this structure in a <code>GetMetricData</code> operation or a <code>PutMetricAlarm</code> operation. These differences are explained in the following parameter list.</p>"
|
||||
},
|
||||
"MetricDataResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2276,6 +2409,47 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"PutCompositeAlarmInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AlarmName",
|
||||
"AlarmRule"
|
||||
],
|
||||
"members":{
|
||||
"ActionsEnabled":{
|
||||
"shape":"ActionsEnabled",
|
||||
"documentation":"<p>Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is <code>TRUE</code>.</p>"
|
||||
},
|
||||
"AlarmActions":{
|
||||
"shape":"ResourceList",
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> </p>"
|
||||
},
|
||||
"AlarmDescription":{
|
||||
"shape":"AlarmDescription",
|
||||
"documentation":"<p>The description for the composite alarm.</p>"
|
||||
},
|
||||
"AlarmName":{
|
||||
"shape":"AlarmName",
|
||||
"documentation":"<p>The name for the composite alarm. This name must be unique within your AWS account.</p>"
|
||||
},
|
||||
"AlarmRule":{
|
||||
"shape":"AlarmRule",
|
||||
"documentation":"<p>An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.</p> <p>You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.</p> <p>Functions can include the following:</p> <ul> <li> <p> <code>ALARM(\"<i>alarm-name</i> or <i>alarm-ARN</i>\")</code> is TRUE if the named alarm is in ALARM state.</p> </li> <li> <p> <code>OK(\"<i>alarm-name</i> or <i>alarm-ARN</i>\")</code> is TRUE if the named alarm is in OK state.</p> </li> <li> <p> <code>INSUFFICIENT_DATA(\"<i>alarm-name</i> or <i>alarm-ARN</i>\")</code> is TRUE if the named alarm is in INSUFFICIENT_DATA state.</p> </li> <li> <p> <code>TRUE</code> always evaluates to TRUE.</p> </li> <li> <p> <code>FALSE</code> always evaluates to FALSE.</p> </li> </ul> <p>TRUE and FALSE are useful for testing a complex <code>AlarmRule</code> structure, and for testing your alarm actions.</p> <p>Alarm names specified in <code>AlarmRule</code> can be surrounded with double-quotes (\"), but do not have to be.</p> <p>The following are some examples of <code>AlarmRule</code>:</p> <ul> <li> <p> <code>ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)</code> specifies that the composite alarm goes into ALARM state only if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.</p> </li> <li> <p> <code>ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)</code> specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is not in ALARM state. This example reduces alarm noise during a known deployment window.</p> </li> <li> <p> <code>(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)</code> goes into ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state. This provides another example of using a composite alarm to prevent noise. This rule ensures that you are not notified with an alarm action on high CPU or disk usage if a known network problem is also occurring.</p> </li> </ul> <p>The <code>AlarmRule</code> can specify as many as 100 \"children\" alarms. The <code>AlarmRule</code> expression can have as many as 500 elements. Elements are child alarms, TRUE or FALSE statements, and parentheses.</p>"
|
||||
},
|
||||
"InsufficientDataActions":{
|
||||
"shape":"ResourceList",
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> </p>"
|
||||
},
|
||||
"OKActions":{
|
||||
"shape":"ResourceList",
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to an <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> </p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.</p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PutDashboardInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2289,7 +2463,7 @@
|
|||
},
|
||||
"DashboardBody":{
|
||||
"shape":"DashboardBody",
|
||||
"documentation":"<p>The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.</p> <p>For more information about the syntax, see <a>CloudWatch-Dashboard-Body-Structure</a>.</p>"
|
||||
"documentation":"<p>The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.</p> <p>For more information about the syntax, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html\">Dashboard Body Structure and Syntax</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2350,15 +2524,15 @@
|
|||
},
|
||||
"OKActions":{
|
||||
"shape":"ResourceList",
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to an <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> | <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> | <code>arn:aws:automate:<i>region</i>:ec2:recover</code> | <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> | <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> | <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </code> </p> <p>Valid Values (for use with IAM roles): <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> </p>"
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to an <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> | <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> | <code>arn:aws:automate:<i>region</i>:ec2:recover</code> | <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> | <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> | <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>:autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </code> </p> <p>Valid Values (for use with IAM roles): <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> </p>"
|
||||
},
|
||||
"AlarmActions":{
|
||||
"shape":"ResourceList",
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> | <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> | <code>arn:aws:automate:<i>region</i>:ec2:recover</code> | <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> | <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> | <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </code> </p> <p>Valid Values (for use with IAM roles): <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> </p>"
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> | <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> | <code>arn:aws:automate:<i>region</i>:ec2:recover</code> | <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> | <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> | <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>:autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </code> </p> <p>Valid Values (for use with IAM roles): <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> </p>"
|
||||
},
|
||||
"InsufficientDataActions":{
|
||||
"shape":"ResourceList",
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> | <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> | <code>arn:aws:automate:<i>region</i>:ec2:recover</code> | <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> | <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> | <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </code> </p> <p>Valid Values (for use with IAM roles): <code>>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> </p>"
|
||||
"documentation":"<p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> | <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> | <code>arn:aws:automate:<i>region</i>:ec2:recover</code> | <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> | <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> </code> | <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>:autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </code> </p> <p>Valid Values (for use with IAM roles): <code>>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> | <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> </p>"
|
||||
},
|
||||
"MetricName":{
|
||||
"shape":"MetricName",
|
||||
|
|
@ -2414,7 +2588,7 @@
|
|||
},
|
||||
"Metrics":{
|
||||
"shape":"MetricDataQueries",
|
||||
"documentation":"<p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm based on the result of a metric math expression. For each <code>PutMetricAlarm</code> operation, you must specify either <code>MetricName</code> or a <code>Metrics</code> array.</p> <p>Each item in the <code>Metrics</code> array either retrieves a metric or performs a math expression.</p> <p>One item in the <code>Metrics</code> array is the expression that the alarm watches. You designate this expression by setting <code>ReturnValue</code> to true for this object in the array. For more information, see <a>MetricDataQuery</a>.</p> <p>If you use the <code>Metrics</code> parameter, you cannot include the <code>MetricName</code>, <code>Dimensions</code>, <code>Period</code>, <code>Namespace</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the <code>Metrics</code> array.</p>"
|
||||
"documentation":"<p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm based on the result of a metric math expression. For each <code>PutMetricAlarm</code> operation, you must specify either <code>MetricName</code> or a <code>Metrics</code> array.</p> <p>Each item in the <code>Metrics</code> array either retrieves a metric or performs a math expression.</p> <p>One item in the <code>Metrics</code> array is the expression that the alarm watches. You designate this expression by setting <code>ReturnValue</code> to true for this object in the array. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html\">MetricDataQuery</a>.</p> <p>If you use the <code>Metrics</code> parameter, you cannot include the <code>MetricName</code>, <code>Dimensions</code>, <code>Period</code>, <code>Namespace</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the <code>Metrics</code> array.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -2537,7 +2711,7 @@
|
|||
},
|
||||
"StateReasonData":{
|
||||
"shape":"StateReasonData",
|
||||
"documentation":"<p>The reason that this alarm is set to this specific state, in JSON format.</p>"
|
||||
"documentation":"<p>The reason that this alarm is set to this specific state, in JSON format.</p> <p>For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -13,6 +13,19 @@
|
|||
"state": "success"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CompositeAlarmExists": {
|
||||
"delay": 5,
|
||||
"maxAttempts": 40,
|
||||
"operation": "DescribeAlarms",
|
||||
"acceptors": [
|
||||
{
|
||||
"matcher": "path",
|
||||
"expected": true,
|
||||
"argument": "length(CompositeAlarms[]) > `0`",
|
||||
"state": "success"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Provides the configuration to use for an agent of the profiling group.</p>"
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"CreateProfilingGroup":{
|
||||
"name":"CreateProfilingGroup",
|
||||
|
|
@ -45,7 +45,7 @@
|
|||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p>Create a profiling group.</p>",
|
||||
"documentation":"<p>Creates a profiling group.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"DeleteProfilingGroup":{
|
||||
|
|
@ -63,7 +63,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Delete a profiling group.</p>",
|
||||
"documentation":"<p>Deletes a profiling group.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"DescribeProfilingGroup":{
|
||||
|
|
@ -81,7 +81,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Describe a profiling group.</p>"
|
||||
"documentation":"<p>Describes a profiling group.</p>"
|
||||
},
|
||||
"GetProfile":{
|
||||
"name":"GetProfile",
|
||||
|
|
@ -98,7 +98,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Get the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it will be expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range. For instance, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, then the returned profile will be from 00:15 to 00:20.</p>"
|
||||
"documentation":"<p>Gets the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it is expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range. </p> <p>For example, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, the returned profile will be from 00:15 to 00:20. </p> <p>You must specify exactly two of the following parameters: <code>startTime</code>, <code>period</code>, and <code>endTime</code>. </p>"
|
||||
},
|
||||
"ListProfileTimes":{
|
||||
"name":"ListProfileTimes",
|
||||
|
|
@ -130,7 +130,7 @@
|
|||
{"shape":"InternalServerException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p>List profiling groups in the account.</p>"
|
||||
"documentation":"<p>Lists profiling groups.</p>"
|
||||
},
|
||||
"PostAgentProfile":{
|
||||
"name":"PostAgentProfile",
|
||||
|
|
@ -147,7 +147,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Submit profile collected by an agent belonging to a profiling group for aggregation.</p>"
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"UpdateProfilingGroup":{
|
||||
"name":"UpdateProfilingGroup",
|
||||
|
|
@ -165,7 +165,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Update a profiling group.</p>",
|
||||
"documentation":"<p>Updates a profiling group.</p>",
|
||||
"idempotent":true
|
||||
}
|
||||
},
|
||||
|
|
@ -179,14 +179,14 @@
|
|||
"members":{
|
||||
"periodInSeconds":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>Specifies the period to follow the configuration (to profile or not) and call back to get a new configuration.</p>"
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"shouldProfile":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Specifies if the profiling should be enabled by the agent.</p>"
|
||||
"documentation":"<p/>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration for the agent to use.</p>"
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"AgentOrchestrationConfig":{
|
||||
"type":"structure",
|
||||
|
|
@ -194,36 +194,29 @@
|
|||
"members":{
|
||||
"profilingEnabled":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>If the agents should be enabled to create and report profiles.</p>"
|
||||
"documentation":"<p/>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Configuration to orchestrate agents to create and report agent profiles of the profiling group. Agents are orchestrated if they follow the agent orchestration protocol.</p>"
|
||||
},
|
||||
"AgentProfile":{
|
||||
"type":"blob",
|
||||
"documentation":"<p>The profile collected by an agent for a time range.</p>"
|
||||
},
|
||||
"AggregatedProfile":{
|
||||
"type":"blob",
|
||||
"documentation":"<p>The profile representing the aggregation of agent profiles of the profiling group for a time range.</p>"
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"AgentProfile":{"type":"blob"},
|
||||
"AggregatedProfile":{"type":"blob"},
|
||||
"AggregatedProfileTime":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"period":{
|
||||
"shape":"AggregationPeriod",
|
||||
"documentation":"<p>The aggregation period of the aggregated profile.</p>"
|
||||
"documentation":"<p>The time period.</p>"
|
||||
},
|
||||
"start":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The start time of the aggregated profile.</p>"
|
||||
"documentation":"<p>The start time.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The time range of an aggregated profile.</p>"
|
||||
"documentation":"<p>Information about the time range of the latest available aggregated profile.</p>"
|
||||
},
|
||||
"AggregationPeriod":{
|
||||
"type":"string",
|
||||
"documentation":"<p>Periods of time used for aggregation of profiles, represented using ISO 8601 format.</p>",
|
||||
"enum":[
|
||||
"P1D",
|
||||
"PT1H",
|
||||
|
|
@ -236,7 +229,6 @@
|
|||
},
|
||||
"ClientToken":{
|
||||
"type":"string",
|
||||
"documentation":"<p>Client token for the request.</p>",
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"^[\\w-]+$"
|
||||
|
|
@ -245,14 +237,18 @@
|
|||
"type":"structure",
|
||||
"required":["profilingGroupName"],
|
||||
"members":{
|
||||
"fleetInstanceId":{"shape":"FleetInstanceId"},
|
||||
"fleetInstanceId":{
|
||||
"shape":"FleetInstanceId",
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p/>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request for ConfigureAgent operation.</p>"
|
||||
"documentation":"<p>The structure representing the configureAgentRequest.</p>"
|
||||
},
|
||||
"ConfigureAgentResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -260,10 +256,10 @@
|
|||
"members":{
|
||||
"configuration":{
|
||||
"shape":"AgentConfiguration",
|
||||
"documentation":"<p>The configuration for the agent to use.</p>"
|
||||
"documentation":"<p/>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Response for ConfigureAgent operation.</p>",
|
||||
"documentation":"<p>The structure representing the configureAgentResponse.</p>",
|
||||
"payload":"configuration"
|
||||
},
|
||||
"ConflictException":{
|
||||
|
|
@ -272,7 +268,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"documentation":"<p>Request can can cause an inconsistent state for the resource.</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. </p>",
|
||||
"error":{
|
||||
"httpStatusCode":409,
|
||||
"senderFault":true
|
||||
|
|
@ -286,24 +282,34 @@
|
|||
"profilingGroupName"
|
||||
],
|
||||
"members":{
|
||||
"agentOrchestrationConfig":{"shape":"AgentOrchestrationConfig"},
|
||||
"agentOrchestrationConfig":{
|
||||
"shape":"AgentOrchestrationConfig",
|
||||
"documentation":"<p>The agent orchestration configuration.</p>"
|
||||
},
|
||||
"clientToken":{
|
||||
"shape":"ClientToken",
|
||||
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p> <p>This parameter specifies a unique identifier for the new profiling group that helps ensure idempotency.</p>",
|
||||
"idempotencyToken":true,
|
||||
"location":"querystring",
|
||||
"locationName":"clientToken"
|
||||
},
|
||||
"profilingGroupName":{"shape":"ProfilingGroupName"}
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request for CreateProfilingGroup operation.</p>"
|
||||
"documentation":"<p>The structure representing the createProfiliingGroupRequest.</p>"
|
||||
},
|
||||
"CreateProfilingGroupResponse":{
|
||||
"type":"structure",
|
||||
"required":["profilingGroup"],
|
||||
"members":{
|
||||
"profilingGroup":{"shape":"ProfilingGroupDescription"}
|
||||
"profilingGroup":{
|
||||
"shape":"ProfilingGroupDescription",
|
||||
"documentation":"<p>Information about the new profiling group</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Response for CreateProfilingGroup operation.</p>",
|
||||
"documentation":"<p>The structure representing the createProfilingGroupResponse.</p>",
|
||||
"payload":"profilingGroup"
|
||||
},
|
||||
"DeleteProfilingGroupRequest":{
|
||||
|
|
@ -312,17 +318,18 @@
|
|||
"members":{
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The profiling group name to delete.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request for DeleteProfilingGroup operation.</p>"
|
||||
"documentation":"<p>The structure representing the deleteProfilingGroupRequest.</p>"
|
||||
},
|
||||
"DeleteProfilingGroupResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Response for DeleteProfilingGroup operation.</p>"
|
||||
"documentation":"<p>The structure representing the deleteProfilingGroupResponse.</p>"
|
||||
},
|
||||
"DescribeProfilingGroupRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -330,24 +337,27 @@
|
|||
"members":{
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The profiling group name.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request for DescribeProfilingGroup operation.</p>"
|
||||
"documentation":"<p>The structure representing the describeProfilingGroupRequest.</p>"
|
||||
},
|
||||
"DescribeProfilingGroupResponse":{
|
||||
"type":"structure",
|
||||
"required":["profilingGroup"],
|
||||
"members":{
|
||||
"profilingGroup":{"shape":"ProfilingGroupDescription"}
|
||||
"profilingGroup":{
|
||||
"shape":"ProfilingGroupDescription",
|
||||
"documentation":"<p>Information about a profiling group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Response for DescribeProfilingGroup operation.</p>",
|
||||
"documentation":"<p>The structure representing the describeProfilingGroupResponse.</p>",
|
||||
"payload":"profilingGroup"
|
||||
},
|
||||
"FleetInstanceId":{
|
||||
"type":"string",
|
||||
"documentation":"<p>Identifier of the instance of compute fleet being profiled by the agent. For instance, host name in EC2, task id for ECS, function name for AWS Lambda</p>",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"^[\\w-.:/]+$"
|
||||
|
|
@ -358,40 +368,42 @@
|
|||
"members":{
|
||||
"accept":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The format of the profile to return. Supports application/json or application/x-amzn-ion. Defaults to application/x-amzn-ion.</p>",
|
||||
"documentation":"<p>The format of the profile to return. You can choose <code>application/json</code> or the default <code>application/x-amzn-ion</code>. </p>",
|
||||
"location":"header",
|
||||
"locationName":"Accept"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The end time of the profile to get. Either period or endTime must be specified. Must be greater than start and the overall time range to be in the past and not larger than a week.</p>",
|
||||
"documentation":"<p/> <p>You must specify exactly two of the following parameters: <code>startTime</code>, <code>period</code>, and <code>endTime</code>. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"endTime"
|
||||
},
|
||||
"maxDepth":{
|
||||
"shape":"MaxDepth",
|
||||
"documentation":"<p>The maximum depth of the graph.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxDepth"
|
||||
},
|
||||
"period":{
|
||||
"shape":"Period",
|
||||
"documentation":"<p>The period of the profile to get. Exactly two of <code>startTime</code>, <code>period</code> and <code>endTime</code> must be specified. Must be positive and the overall time range to be in the past and not larger than a week.</p>",
|
||||
"documentation":"<p>The period of the profile to get. The time range must be in the past and not longer than one week. </p> <p>You must specify exactly two of the following parameters: <code>startTime</code>, <code>period</code>, and <code>endTime</code>. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"period"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group to get.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The start time of the profile to get.</p>",
|
||||
"documentation":"<p>The start time of the profile to get.</p> <p>You must specify exactly two of the following parameters: <code>startTime</code>, <code>period</code>, and <code>endTime</code>. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"startTime"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request for GetProfile operation.</p>"
|
||||
"documentation":"<p>The structure representing the getProfileRequest.</p>"
|
||||
},
|
||||
"GetProfileResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -402,19 +414,22 @@
|
|||
"members":{
|
||||
"contentEncoding":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The content encoding of the profile in the payload.</p>",
|
||||
"documentation":"<p>The content encoding of the profile.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Content-Encoding"
|
||||
},
|
||||
"contentType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The content type of the profile in the payload. Will be application/json or application/x-amzn-ion based on Accept header in the request.</p>",
|
||||
"documentation":"<p>The content type of the profile in the payload. It is either <code>application/json</code> or the default <code>application/x-amzn-ion</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Content-Type"
|
||||
},
|
||||
"profile":{"shape":"AggregatedProfile"}
|
||||
"profile":{
|
||||
"shape":"AggregatedProfile",
|
||||
"documentation":"<p>Information about the profile.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Response for GetProfile operation.</p>",
|
||||
"documentation":"<p>The structure representing the getProfileResponse.</p>",
|
||||
"payload":"profile"
|
||||
},
|
||||
"Integer":{
|
||||
|
|
@ -427,7 +442,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"documentation":"<p>Unexpected error during processing of request.</p>",
|
||||
"documentation":"<p>The server encountered an internal error and is unable to complete the request.</p>",
|
||||
"error":{"httpStatusCode":500},
|
||||
"exception":true,
|
||||
"fault":true
|
||||
|
|
@ -443,100 +458,115 @@
|
|||
"members":{
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The end time of the time range to list profiles until.</p>",
|
||||
"documentation":"<p>The end time of the time range from which to list the profiles.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"endTime"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of profile time results returned by <code>ListProfileTimes</code> in paginated output. When this parameter is used, <code>ListProfileTimes</code> only returns <code>maxResults</code> results in a single page with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListProfileTimes</code> request with the returned <code>nextToken</code> value. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListProfileTimes</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"orderBy":{
|
||||
"shape":"OrderBy",
|
||||
"documentation":"<p>The order (ascending or descending by start time of the profile) to list the profiles by. Defaults to TIMESTAMP_DESCENDING.</p>",
|
||||
"documentation":"<p>The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to <code>TIMESTAMP_DESCENDING</code>. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"orderBy"
|
||||
},
|
||||
"period":{
|
||||
"shape":"AggregationPeriod",
|
||||
"documentation":"<p>The aggregation period to list the profiles for.</p>",
|
||||
"documentation":"<p>The aggregation period.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"period"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The start time of the time range to list the profiles from.</p>",
|
||||
"documentation":"<p>The start time of the time range from which to list the profiles.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"startTime"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request for ListProfileTimes operation.</p>"
|
||||
"documentation":"<p>The structure representing the listProfileTimesRequest.</p>"
|
||||
},
|
||||
"ListProfileTimesResponse":{
|
||||
"type":"structure",
|
||||
"required":["profileTimes"],
|
||||
"members":{
|
||||
"nextToken":{"shape":"PaginationToken"},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListProfileTimes</code> request. When the results of a <code>ListProfileTimes</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
|
||||
},
|
||||
"profileTimes":{
|
||||
"shape":"ProfileTimes",
|
||||
"documentation":"<p>List of start times of the available profiles for the aggregation period in the specified time range.</p>"
|
||||
"documentation":"<p>The list of start times of the available profiles for the aggregation period in the specified time range. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Response for ListProfileTimes operation.</p>"
|
||||
"documentation":"<p>The structure representing the listProfileTimesResponse.</p>"
|
||||
},
|
||||
"ListProfilingGroupsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"includeDescription":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>If set to true, returns the full description of the profiling groups instead of the names. Defaults to false.</p>",
|
||||
"documentation":"<p>A Boolean value indicating whether to include a description.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"includeDescription"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of profiling groups results returned by <code>ListProfilingGroups</code> in paginated output. When this parameter is used, <code>ListProfilingGroups</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListProfilingGroups</code> request with the returned <code>nextToken</code> value. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListProfilingGroups</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request for ListProfilingGroups operation.</p>"
|
||||
"documentation":"<p>The structure representing the listProfilingGroupsRequest.</p>"
|
||||
},
|
||||
"ListProfilingGroupsResponse":{
|
||||
"type":"structure",
|
||||
"required":["profilingGroupNames"],
|
||||
"members":{
|
||||
"nextToken":{"shape":"PaginationToken"},
|
||||
"profilingGroupNames":{"shape":"ProfilingGroupNames"},
|
||||
"profilingGroups":{"shape":"ProfilingGroupDescriptions"}
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListProfilingGroups</code> request. When the results of a <code>ListProfilingGroups</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
|
||||
},
|
||||
"profilingGroupNames":{
|
||||
"shape":"ProfilingGroupNames",
|
||||
"documentation":"<p>Information about profiling group names.</p>"
|
||||
},
|
||||
"profilingGroups":{
|
||||
"shape":"ProfilingGroupDescriptions",
|
||||
"documentation":"<p>Information about profiling groups.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Response for ListProfilingGroups operation.</p>"
|
||||
"documentation":"<p>The structure representing the listProfilingGroupsResponse.</p>"
|
||||
},
|
||||
"MaxDepth":{
|
||||
"type":"integer",
|
||||
"documentation":"<p>Limit the max depth of the profile.</p>",
|
||||
"box":true,
|
||||
"max":10000,
|
||||
"min":1
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"documentation":"<p>Upper bound on the number of results to list in a single call.</p>",
|
||||
"box":true,
|
||||
"max":1000,
|
||||
"min":1
|
||||
|
|
@ -550,14 +580,12 @@
|
|||
},
|
||||
"PaginationToken":{
|
||||
"type":"string",
|
||||
"documentation":"<p>Token for paginating results.</p>",
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"^[\\w-]+$"
|
||||
},
|
||||
"Period":{
|
||||
"type":"string",
|
||||
"documentation":"<p>Periods of time represented using <a href=\"https://en.wikipedia.org/wiki/ISO_8601#Durations\">ISO 8601 format</a>.</p>",
|
||||
"max":64,
|
||||
"min":1
|
||||
},
|
||||
|
|
@ -569,34 +597,38 @@
|
|||
"profilingGroupName"
|
||||
],
|
||||
"members":{
|
||||
"agentProfile":{"shape":"AgentProfile"},
|
||||
"agentProfile":{
|
||||
"shape":"AgentProfile",
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"contentType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The content type of the agent profile in the payload. Recommended to send the profile gzipped with content-type application/octet-stream. Other accepted values are application/x-amzn-ion and application/json for unzipped Ion and JSON respectively.</p>",
|
||||
"documentation":"<p/>",
|
||||
"location":"header",
|
||||
"locationName":"Content-Type"
|
||||
},
|
||||
"profileToken":{
|
||||
"shape":"ClientToken",
|
||||
"documentation":"<p>Client generated token to deduplicate the agent profile during aggregation.</p>",
|
||||
"documentation":"<p/>",
|
||||
"idempotencyToken":true,
|
||||
"location":"querystring",
|
||||
"locationName":"profileToken"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p/>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request for PostAgentProfile operation.</p>",
|
||||
"documentation":"<p>The structure representing the postAgentProfileRequest.</p>",
|
||||
"payload":"agentProfile"
|
||||
},
|
||||
"PostAgentProfileResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Response for PostAgentProfile operation.</p>"
|
||||
"documentation":"<p>The structure representing the postAgentProfileResponse.</p>"
|
||||
},
|
||||
"ProfileTime":{
|
||||
"type":"structure",
|
||||
|
|
@ -606,69 +638,74 @@
|
|||
"documentation":"<p>The start time of the profile.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Periods of time used for aggregation of profiles, represented using ISO 8601 format.</p>"
|
||||
"documentation":"<p>Information about the profile time.</p>"
|
||||
},
|
||||
"ProfileTimes":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ProfileTime"},
|
||||
"documentation":"<p>List of profile times.</p>"
|
||||
},
|
||||
"ProfilingGroupArn":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The ARN of the profiling group.</p>"
|
||||
"member":{"shape":"ProfileTime"}
|
||||
},
|
||||
"ProfilingGroupArn":{"type":"string"},
|
||||
"ProfilingGroupDescription":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"agentOrchestrationConfig":{"shape":"AgentOrchestrationConfig"},
|
||||
"arn":{"shape":"ProfilingGroupArn"},
|
||||
"agentOrchestrationConfig":{
|
||||
"shape":"AgentOrchestrationConfig",
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"arn":{
|
||||
"shape":"ProfilingGroupArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) identifying the profiling group.</p>"
|
||||
},
|
||||
"createdAt":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The timestamp of when the profiling group was created.</p>"
|
||||
"documentation":"<p>The time, in milliseconds since the epoch, when the profiling group was created.</p>"
|
||||
},
|
||||
"name":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group.</p>"
|
||||
},
|
||||
"profilingStatus":{
|
||||
"shape":"ProfilingStatus",
|
||||
"documentation":"<p>The status of the profiling group.</p>"
|
||||
},
|
||||
"name":{"shape":"ProfilingGroupName"},
|
||||
"profilingStatus":{"shape":"ProfilingStatus"},
|
||||
"updatedAt":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The timestamp of when the profiling group was last updated.</p>"
|
||||
"documentation":"<p>The time, in milliseconds since the epoch, when the profiling group was last updated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The description of a profiling group.</p>"
|
||||
},
|
||||
"ProfilingGroupDescriptions":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ProfilingGroupDescription"},
|
||||
"documentation":"<p>List of profiling group descriptions.</p>"
|
||||
"member":{"shape":"ProfilingGroupDescription"}
|
||||
},
|
||||
"ProfilingGroupName":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The name of the profiling group.</p>",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"^[\\w-]+$"
|
||||
},
|
||||
"ProfilingGroupNames":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ProfilingGroupName"},
|
||||
"documentation":"<p>List of profiling group names.</p>"
|
||||
"member":{"shape":"ProfilingGroupName"}
|
||||
},
|
||||
"ProfilingStatus":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"latestAgentOrchestratedAt":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Timestamp of when the last interaction of the agent with configureAgent API for orchestration.</p>"
|
||||
"documentation":"<p>The time, in milliseconds since the epoch, when the latest agent was orchestrated.</p>"
|
||||
},
|
||||
"latestAgentProfileReportedAt":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Timestamp of when the latest agent profile was successfully reported.</p>"
|
||||
"documentation":"<p>The time, in milliseconds since the epoch, when the latest agent was reported..</p>"
|
||||
},
|
||||
"latestAggregatedProfile":{
|
||||
"shape":"AggregatedProfileTime",
|
||||
"documentation":"<p>The time range of latest aggregated profile available.</p>"
|
||||
"documentation":"<p>The latest aggregated profile</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The status of profiling of a profiling group.</p>"
|
||||
"documentation":"<p>Information about the profiling status.</p>"
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
|
|
@ -676,7 +713,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"documentation":"<p>Request references a resource which does not exist.</p>",
|
||||
"documentation":"<p>The resource specified in the request does not exist.</p>",
|
||||
"error":{
|
||||
"httpStatusCode":404,
|
||||
"senderFault":true
|
||||
|
|
@ -689,7 +726,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"documentation":"<p>Request would cause a service quota to be exceeded.</p>",
|
||||
"documentation":"<p>You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use <a href=\"https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html\">Service Quotas</a> to request a service quota increase. </p>",
|
||||
"error":{
|
||||
"httpStatusCode":402,
|
||||
"senderFault":true
|
||||
|
|
@ -703,7 +740,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"documentation":"<p>Request was denied due to request throttling.</p>",
|
||||
"documentation":"<p>The request was denied due to request throttling.</p>",
|
||||
"error":{
|
||||
"httpStatusCode":429,
|
||||
"senderFault":true
|
||||
|
|
@ -723,23 +760,27 @@
|
|||
"members":{
|
||||
"agentOrchestrationConfig":{
|
||||
"shape":"AgentOrchestrationConfig",
|
||||
"documentation":"<p>Remote configuration to configure the agents of the profiling group.</p>"
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group to update.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Request for UpdateProfilingGroup operation.</p>"
|
||||
"documentation":"<p>The structure representing the updateProfilingGroupRequest.</p>"
|
||||
},
|
||||
"UpdateProfilingGroupResponse":{
|
||||
"type":"structure",
|
||||
"required":["profilingGroup"],
|
||||
"members":{
|
||||
"profilingGroup":{"shape":"ProfilingGroupDescription"}
|
||||
"profilingGroup":{
|
||||
"shape":"ProfilingGroupDescription",
|
||||
"documentation":"<p>Updated information about the profiling group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Response for UpdateProfilingGroup operation.</p>",
|
||||
"documentation":"<p>The structure representing the updateProfilingGroupResponse.</p>",
|
||||
"payload":"profilingGroup"
|
||||
},
|
||||
"ValidationException":{
|
||||
|
|
@ -748,7 +789,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"documentation":"<p>The input fails to satisfy the constraints of the API.</p>",
|
||||
"documentation":"<p>The parameter is not valid.</p>",
|
||||
"error":{
|
||||
"httpStatusCode":400,
|
||||
"senderFault":true
|
||||
|
|
@ -756,5 +797,5 @@
|
|||
"exception":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Example service documentation.</p>"
|
||||
"documentation":"<p>This section provides documentation for the Amazon CodeGuru Profiler API operations.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1109,7 +1109,7 @@
|
|||
{"shape":"UserNotConfirmedException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the <code>Username</code> parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, <code>InvalidParameterException</code> is thrown. To use the confirmation code for resetting the password, call .</p>",
|
||||
"documentation":"<p>Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the <code>Username</code> parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see <a href=\"\">Recovering User Accounts</a> in the <i>Amazon Cognito Developer Guide</i>. If neither a verified phone number nor a verified email exists, an <code>InvalidParameterException</code> is thrown. To use the confirmation code for resetting the password, call .</p>",
|
||||
"authtype":"none"
|
||||
},
|
||||
"GetCSVHeader":{
|
||||
|
|
@ -3033,7 +3033,7 @@
|
|||
"documentation":"<p>If <code>UserDataShared</code> is <code>true</code>, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.</p>"
|
||||
"documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.</p> <note> <p>Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.</p> </note>"
|
||||
},
|
||||
"AnalyticsMetadataType":{
|
||||
"type":"structure",
|
||||
|
|
@ -3043,7 +3043,7 @@
|
|||
"documentation":"<p>The endpoint ID.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An Amazon Pinpoint analytics endpoint.</p> <p>An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.</p>"
|
||||
"documentation":"<p>An Amazon Pinpoint analytics endpoint.</p> <p>An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.</p> <note> <p>Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.</p> </note>"
|
||||
},
|
||||
"ArnType":{
|
||||
"type":"string",
|
||||
|
|
@ -3187,7 +3187,11 @@
|
|||
"AuthParametersType":{
|
||||
"type":"map",
|
||||
"key":{"shape":"StringType"},
|
||||
"value":{"shape":"StringType"}
|
||||
"value":{"shape":"AuthParametersValueType"}
|
||||
},
|
||||
"AuthParametersValueType":{
|
||||
"type":"string",
|
||||
"sensitive":true
|
||||
},
|
||||
"AuthenticationResultType":{
|
||||
"type":"structure",
|
||||
|
|
@ -3681,7 +3685,7 @@
|
|||
},
|
||||
"ProviderDetails":{
|
||||
"shape":"ProviderDetailsType",
|
||||
"documentation":"<p>The identity provider details, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>"
|
||||
"documentation":"<p>The identity provider details. The following list describes the provider detail keys for each identity provider type.</p> <ul> <li> <p>For Google, Facebook and Login with Amazon:</p> <ul> <li> <p>client_id</p> </li> <li> <p>client_secret</p> </li> <li> <p>authorize_scopes</p> </li> </ul> </li> <li> <p>For Sign in with Apple:</p> <ul> <li> <p>client_id</p> </li> <li> <p>team_id</p> </li> <li> <p>key_id</p> </li> <li> <p>private_key</p> </li> <li> <p>authorize_scopes</p> </li> </ul> </li> <li> <p>For OIDC providers:</p> <ul> <li> <p>client_id</p> </li> <li> <p>client_secret</p> </li> <li> <p>attributes_request_method</p> </li> <li> <p>oidc_issuer</p> </li> <li> <p>authorize_scopes</p> </li> <li> <p>authorize_url <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p>token_url <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p>attributes_url <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p>jwks_uri <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p>authorize_scopes</p> </li> </ul> </li> <li> <p>For SAML providers:</p> <ul> <li> <p>MetadataFile OR MetadataURL</p> </li> <li> <p>IDPSignout <i>optional</i> </p> </li> </ul> </li> </ul>"
|
||||
},
|
||||
"AttributeMapping":{
|
||||
"shape":"AttributeMappingType",
|
||||
|
|
@ -3825,23 +3829,23 @@
|
|||
},
|
||||
"AllowedOAuthFlows":{
|
||||
"shape":"OAuthFlowsType",
|
||||
"documentation":"<p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p> <p>Set to <code>token</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p>"
|
||||
"documentation":"<p>The allowed OAuth flows.</p> <p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p> <p>Set to <code>implicit</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p> <p>Set to <code>client_credentials</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.</p>"
|
||||
},
|
||||
"AllowedOAuthScopes":{
|
||||
"shape":"ScopeListType",
|
||||
"documentation":"<p>A list of allowed <code>OAuth</code> scopes. Currently supported values are <code>\"phone\"</code>, <code>\"email\"</code>, <code>\"openid\"</code>, and <code>\"Cognito\"</code>. In addition to these values, custom scopes created in Resource Servers are also supported.</p>"
|
||||
"documentation":"<p>The allowed OAuth scopes. Possible values provided by OAuth are: <code>phone</code>, <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values provided by AWS are: <code>aws.cognito.signin.user.admin</code>. Custom scopes created in Resource Servers are also supported.</p>"
|
||||
},
|
||||
"AllowedOAuthFlowsUserPoolClient":{
|
||||
"shape":"BooleanType",
|
||||
"documentation":"<p>Set to <code>True</code> if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>"
|
||||
"documentation":"<p>Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>"
|
||||
},
|
||||
"AnalyticsConfiguration":{
|
||||
"shape":"AnalyticsConfigurationType",
|
||||
"documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p>"
|
||||
"documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p> <note> <p>Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.</p> </note>"
|
||||
},
|
||||
"PreventUserExistenceErrors":{
|
||||
"shape":"PreventUserExistenceErrorTypes",
|
||||
"documentation":"<p>Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to <code>ENABLED</code> and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs will return a <code>UserNotFoundException</code> exception if the user does not exist in the user pool.</p> <p>Valid values include:</p> <ul> <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li> <li> <p> <code>LEGACY</code> - This represents the old behavior of Cognito where user existence related errors are not prevented.</p> </li> </ul> <p>This setting affects the behavior of following APIs:</p> <ul> <li> <p> <a>AdminInitiateAuth</a> </p> </li> <li> <p> <a>AdminRespondToAuthChallenge</a> </p> </li> <li> <p> <a>InitiateAuth</a> </p> </li> <li> <p> <a>RespondToAuthChallenge</a> </p> </li> <li> <p> <a>ForgotPassword</a> </p> </li> <li> <p> <a>ConfirmForgotPassword</a> </p> </li> <li> <p> <a>ConfirmSignUp</a> </p> </li> <li> <p> <a>ResendConfirmationCode</a> </p> </li> </ul> <note> <p>After January 1st 2020, the value of <code>PreventUserExistenceErrors</code> will default to <code>ENABLED</code> for newly created user pool clients if no value is provided.</p> </note>"
|
||||
"documentation":"<p>Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to <code>ENABLED</code> and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs will return a <code>UserNotFoundException</code> exception if the user does not exist in the user pool.</p> <p>Valid values include:</p> <ul> <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li> <li> <p> <code>LEGACY</code> - This represents the old behavior of Cognito where user existence related errors are not prevented.</p> </li> </ul> <p>This setting affects the behavior of following APIs:</p> <ul> <li> <p> <a>AdminInitiateAuth</a> </p> </li> <li> <p> <a>AdminRespondToAuthChallenge</a> </p> </li> <li> <p> <a>InitiateAuth</a> </p> </li> <li> <p> <a>RespondToAuthChallenge</a> </p> </li> <li> <p> <a>ForgotPassword</a> </p> </li> <li> <p> <a>ConfirmForgotPassword</a> </p> </li> <li> <p> <a>ConfirmSignUp</a> </p> </li> <li> <p> <a>ResendConfirmationCode</a> </p> </li> </ul> <note> <p>After February 15th 2020, the value of <code>PreventUserExistenceErrors</code> will default to <code>ENABLED</code> for newly created user pool clients if no value is provided.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to create a user pool client.</p>"
|
||||
|
|
@ -3966,6 +3970,10 @@
|
|||
"shape":"UserPoolAddOnsType",
|
||||
"documentation":"<p>Used to enable advanced security risk detection. Set the key <code>AdvancedSecurityMode</code> to the value \"AUDIT\".</p>"
|
||||
},
|
||||
"UsernameConfiguration":{
|
||||
"shape":"UsernameConfigurationType",
|
||||
"documentation":"<p>You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to <code>False</code>, users will be able to sign in using either \"username\" or \"Username\". This configuration is immutable once it has been set. For more information, see .</p>"
|
||||
},
|
||||
"AccountRecoverySetting":{
|
||||
"shape":"AccountRecoverySettingType",
|
||||
"documentation":"<p>Use this setting to define which verified available method a user can use to recover their password when they call <code>ForgotPassword</code>. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.</p> <note> <p>Starting February 1, 2020, the value of <code>AccountRecoverySetting</code> will default to <code>verified_email</code> first and <code>verified_phone_number</code> as the second option for newly created user pools if no value is provided.</p> </note>"
|
||||
|
|
@ -4647,6 +4655,10 @@
|
|||
"RiskLevel":{
|
||||
"shape":"RiskLevelType",
|
||||
"documentation":"<p>The risk level.</p>"
|
||||
},
|
||||
"CompromisedCredentialsDetected":{
|
||||
"shape":"WrappedBooleanType",
|
||||
"documentation":"<p>Indicates whether compromised credentials were detected during an authentication event.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The event risk type.</p>"
|
||||
|
|
@ -5112,7 +5124,7 @@
|
|||
},
|
||||
"ProviderDetails":{
|
||||
"shape":"ProviderDetailsType",
|
||||
"documentation":"<p>The identity provider details, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>"
|
||||
"documentation":"<p>The identity provider details. The following list describes the provider detail keys for each identity provider type.</p> <ul> <li> <p>For Google, Facebook and Login with Amazon:</p> <ul> <li> <p>client_id</p> </li> <li> <p>client_secret</p> </li> <li> <p>authorize_scopes</p> </li> </ul> </li> <li> <p>For Sign in with Apple:</p> <ul> <li> <p>client_id</p> </li> <li> <p>team_id</p> </li> <li> <p>key_id</p> </li> <li> <p>private_key</p> </li> <li> <p>authorize_scopes</p> </li> </ul> </li> <li> <p>For OIDC providers:</p> <ul> <li> <p>client_id</p> </li> <li> <p>client_secret</p> </li> <li> <p>attributes_request_method</p> </li> <li> <p>oidc_issuer</p> </li> <li> <p>authorize_scopes</p> </li> <li> <p>authorize_url <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p>token_url <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p>attributes_url <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p>jwks_uri <i>if not available from discovery URL specified by oidc_issuer key</i> </p> </li> <li> <p>authorize_scopes</p> </li> </ul> </li> <li> <p>For SAML providers:</p> <ul> <li> <p>MetadataFile OR MetadataURL</p> </li> <li> <p>IDPSignOut <i>optional</i> </p> </li> </ul> </li> </ul>"
|
||||
},
|
||||
"AttributeMapping":{
|
||||
"shape":"AttributeMappingType",
|
||||
|
|
@ -6374,7 +6386,7 @@
|
|||
},
|
||||
"DeveloperOnlyAttribute":{
|
||||
"shape":"BooleanType",
|
||||
"documentation":"<p>Specifies whether the attribute type is developer only.</p>",
|
||||
"documentation":"<note> <p>We recommend that you use <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes\">WriteAttributes</a> in the user pool client to control how attributes can be mutated for new use cases instead of using <code>DeveloperOnlyAttribute</code>.</p> </note> <p>Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users will not be able to modify this attribute using their access token. For example, <code>DeveloperOnlyAttribute</code> can be modified using the API but cannot be updated using the API.</p>",
|
||||
"box":true
|
||||
},
|
||||
"Mutable":{
|
||||
|
|
@ -7246,23 +7258,23 @@
|
|||
},
|
||||
"AllowedOAuthFlows":{
|
||||
"shape":"OAuthFlowsType",
|
||||
"documentation":"<p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p>"
|
||||
"documentation":"<p>The allowed OAuth flows.</p> <p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p> <p>Set to <code>implicit</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p> <p>Set to <code>client_credentials</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.</p>"
|
||||
},
|
||||
"AllowedOAuthScopes":{
|
||||
"shape":"ScopeListType",
|
||||
"documentation":"<p>A list of allowed <code>OAuth</code> scopes. Currently supported values are <code>\"phone\"</code>, <code>\"email\"</code>, <code>\"openid\"</code>, and <code>\"Cognito\"</code>. In addition to these values, custom scopes created in Resource Servers are also supported.</p>"
|
||||
"documentation":"<p>The allowed OAuth scopes. Possible values provided by OAuth are: <code>phone</code>, <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values provided by AWS are: <code>aws.cognito.signin.user.admin</code>. Custom scopes created in Resource Servers are also supported.</p>"
|
||||
},
|
||||
"AllowedOAuthFlowsUserPoolClient":{
|
||||
"shape":"BooleanType",
|
||||
"documentation":"<p>Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>"
|
||||
"documentation":"<p>Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>"
|
||||
},
|
||||
"AnalyticsConfiguration":{
|
||||
"shape":"AnalyticsConfigurationType",
|
||||
"documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p>"
|
||||
"documentation":"<p>The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.</p> <note> <p>Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.</p> </note>"
|
||||
},
|
||||
"PreventUserExistenceErrors":{
|
||||
"shape":"PreventUserExistenceErrorTypes",
|
||||
"documentation":"<p>Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to <code>ENABLED</code> and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs will return a <code>UserNotFoundException</code> exception if the user does not exist in the user pool.</p> <p>Valid values include:</p> <ul> <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li> <li> <p> <code>LEGACY</code> - This represents the old behavior of Cognito where user existence related errors are not prevented.</p> </li> </ul> <p>This setting affects the behavior of following APIs:</p> <ul> <li> <p> <a>AdminInitiateAuth</a> </p> </li> <li> <p> <a>AdminRespondToAuthChallenge</a> </p> </li> <li> <p> <a>InitiateAuth</a> </p> </li> <li> <p> <a>RespondToAuthChallenge</a> </p> </li> <li> <p> <a>ForgotPassword</a> </p> </li> <li> <p> <a>ConfirmForgotPassword</a> </p> </li> <li> <p> <a>ConfirmSignUp</a> </p> </li> <li> <p> <a>ResendConfirmationCode</a> </p> </li> </ul> <note> <p>After January 1st 2020, the value of <code>PreventUserExistenceErrors</code> will default to <code>ENABLED</code> for newly created user pool clients if no value is provided.</p> </note>"
|
||||
"documentation":"<p>Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to <code>ENABLED</code> and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs will return a <code>UserNotFoundException</code> exception if the user does not exist in the user pool.</p> <p>Valid values include:</p> <ul> <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li> <li> <p> <code>LEGACY</code> - This represents the old behavior of Cognito where user existence related errors are not prevented.</p> </li> </ul> <p>This setting affects the behavior of following APIs:</p> <ul> <li> <p> <a>AdminInitiateAuth</a> </p> </li> <li> <p> <a>AdminRespondToAuthChallenge</a> </p> </li> <li> <p> <a>InitiateAuth</a> </p> </li> <li> <p> <a>RespondToAuthChallenge</a> </p> </li> <li> <p> <a>ForgotPassword</a> </p> </li> <li> <p> <a>ConfirmForgotPassword</a> </p> </li> <li> <p> <a>ConfirmSignUp</a> </p> </li> <li> <p> <a>ResendConfirmationCode</a> </p> </li> </ul> <note> <p>After February 15th 2020, the value of <code>PreventUserExistenceErrors</code> will default to <code>ENABLED</code> for newly created user pool clients if no value is provided.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to update the user pool client.</p>"
|
||||
|
|
@ -7644,24 +7656,24 @@
|
|||
},
|
||||
"AllowedOAuthFlows":{
|
||||
"shape":"OAuthFlowsType",
|
||||
"documentation":"<p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p> <p>Set to <code>token</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p>"
|
||||
"documentation":"<p>The allowed OAuth flows.</p> <p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p> <p>Set to <code>implicit</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p> <p>Set to <code>client_credentials</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.</p>"
|
||||
},
|
||||
"AllowedOAuthScopes":{
|
||||
"shape":"ScopeListType",
|
||||
"documentation":"<p>A list of allowed <code>OAuth</code> scopes. Currently supported values are <code>\"phone\"</code>, <code>\"email\"</code>, <code>\"openid\"</code>, and <code>\"Cognito\"</code>. In addition to these values, custom scopes created in Resource Servers are also supported.</p>"
|
||||
"documentation":"<p>The allowed OAuth scopes. Possible values provided by OAuth are: <code>phone</code>, <code>email</code>, <code>openid</code>, and <code>profile</code>. Possible values provided by AWS are: <code>aws.cognito.signin.user.admin</code>. Custom scopes created in Resource Servers are also supported.</p>"
|
||||
},
|
||||
"AllowedOAuthFlowsUserPoolClient":{
|
||||
"shape":"BooleanType",
|
||||
"documentation":"<p>Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>",
|
||||
"documentation":"<p>Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>",
|
||||
"box":true
|
||||
},
|
||||
"AnalyticsConfiguration":{
|
||||
"shape":"AnalyticsConfigurationType",
|
||||
"documentation":"<p>The Amazon Pinpoint analytics configuration for the user pool client.</p>"
|
||||
"documentation":"<p>The Amazon Pinpoint analytics configuration for the user pool client.</p> <note> <p>Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.</p> </note>"
|
||||
},
|
||||
"PreventUserExistenceErrors":{
|
||||
"shape":"PreventUserExistenceErrorTypes",
|
||||
"documentation":"<p>Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to <code>ENABLED</code> and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs will return a <code>UserNotFoundException</code> exception if the user does not exist in the user pool.</p> <p>Valid values include:</p> <ul> <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li> <li> <p> <code>LEGACY</code> - This represents the old behavior of Cognito where user existence related errors are not prevented.</p> </li> </ul> <p>This setting affects the behavior of following APIs:</p> <ul> <li> <p> <a>AdminInitiateAuth</a> </p> </li> <li> <p> <a>AdminRespondToAuthChallenge</a> </p> </li> <li> <p> <a>InitiateAuth</a> </p> </li> <li> <p> <a>RespondToAuthChallenge</a> </p> </li> <li> <p> <a>ForgotPassword</a> </p> </li> <li> <p> <a>ConfirmForgotPassword</a> </p> </li> <li> <p> <a>ConfirmSignUp</a> </p> </li> <li> <p> <a>ResendConfirmationCode</a> </p> </li> </ul> <note> <p>After January 1st 2020, the value of <code>PreventUserExistenceErrors</code> will default to <code>ENABLED</code> for newly created user pool clients if no value is provided.</p> </note>"
|
||||
"documentation":"<p>Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to <code>ENABLED</code> and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to <code>LEGACY</code>, those APIs will return a <code>UserNotFoundException</code> exception if the user does not exist in the user pool.</p> <p>Valid values include:</p> <ul> <li> <p> <code>ENABLED</code> - This prevents user existence-related errors.</p> </li> <li> <p> <code>LEGACY</code> - This represents the old behavior of Cognito where user existence related errors are not prevented.</p> </li> </ul> <p>This setting affects the behavior of following APIs:</p> <ul> <li> <p> <a>AdminInitiateAuth</a> </p> </li> <li> <p> <a>AdminRespondToAuthChallenge</a> </p> </li> <li> <p> <a>InitiateAuth</a> </p> </li> <li> <p> <a>RespondToAuthChallenge</a> </p> </li> <li> <p> <a>ForgotPassword</a> </p> </li> <li> <p> <a>ConfirmForgotPassword</a> </p> </li> <li> <p> <a>ConfirmSignUp</a> </p> </li> <li> <p> <a>ResendConfirmationCode</a> </p> </li> </ul> <note> <p>After February 15th 2020, the value of <code>PreventUserExistenceErrors</code> will default to <code>ENABLED</code> for newly created user pool clients if no value is provided.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about a user pool client.</p>"
|
||||
|
|
@ -7862,6 +7874,10 @@
|
|||
"shape":"UserPoolAddOnsType",
|
||||
"documentation":"<p>The user pool add-ons.</p>"
|
||||
},
|
||||
"UsernameConfiguration":{
|
||||
"shape":"UsernameConfigurationType",
|
||||
"documentation":"<p>You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to <code>False</code>, users will be able to sign in using either \"username\" or \"Username\". This configuration is immutable once it has been set. For more information, see .</p>"
|
||||
},
|
||||
"Arn":{
|
||||
"shape":"ArnType",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the user pool.</p>"
|
||||
|
|
@ -7930,6 +7946,17 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"UsernameAttributeType"}
|
||||
},
|
||||
"UsernameConfigurationType":{
|
||||
"type":"structure",
|
||||
"required":["CaseSensitive"],
|
||||
"members":{
|
||||
"CaseSensitive":{
|
||||
"shape":"WrappedBooleanType",
|
||||
"documentation":"<p>Specifies whether username case sensitivity will be applied for all users in the user pool through Cognito APIs.</p> <p>Valid values include:</p> <ul> <li> <p> <b> <code>True</code> </b>: Enables case sensitivity for all username input. When this option is set to <code>True</code>, users must sign in using the exact capitalization of their given username. For example, “UserName”. This is the default value.</p> </li> <li> <p> <b> <code>False</code> </b>: Enables case insensitivity for all username input. For example, when this option is set to <code>False</code>, users will be able to sign in using either \"username\" or \"Username\". This option also enables both <code>preferred_username</code> and <code>email</code> alias to be case insensitive, in addition to the <code>username</code> attribute.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The username configuration type. </p>"
|
||||
},
|
||||
"UsernameExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -8063,7 +8090,8 @@
|
|||
"members":{
|
||||
},
|
||||
"documentation":"<p>A container representing the response from the server from the request to verify user attributes.</p>"
|
||||
}
|
||||
},
|
||||
"WrappedBooleanType":{"type":"boolean"}
|
||||
},
|
||||
"documentation":"<p>Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.</p> <p>This API reference provides information about user pools in Amazon Cognito User Pools.</p> <p>For more information, see the Amazon Cognito Documentation.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@
|
|||
{"shape":"InvalidEncodingException"},
|
||||
{"shape":"TextSizeLimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.</p> <p>The <code>DetectEntitiesV2</code> operation replaces the <a>DetectEntities</a> operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the <code>DetectEntitiesV2</code> operation in all new applications.</p> <p>The <code>DetectEntitiesV2</code> operation returns the <code>Acuity</code> and <code>Direction</code> entities as attributes instead of types. </p>"
|
||||
"documentation":"<p>Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information. Amazon Comprehend Medical only detects medical entities in English language texts.</p> <p>The <code>DetectEntitiesV2</code> operation replaces the <a>DetectEntities</a> operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the <code>DetectEntitiesV2</code> operation in all new applications.</p> <p>The <code>DetectEntitiesV2</code> operation returns the <code>Acuity</code> and <code>Direction</code> entities as attributes instead of types. </p>"
|
||||
},
|
||||
"DetectPHI":{
|
||||
"name":"DetectPHI",
|
||||
|
|
@ -100,7 +100,7 @@
|
|||
{"shape":"InvalidEncodingException"},
|
||||
{"shape":"TextSizeLimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.</p>"
|
||||
"documentation":"<p> Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.</p>"
|
||||
},
|
||||
"InferICD10CM":{
|
||||
"name":"InferICD10CM",
|
||||
|
|
@ -118,7 +118,7 @@
|
|||
{"shape":"InvalidEncodingException"},
|
||||
{"shape":"TextSizeLimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control.</p>"
|
||||
"documentation":"<p>InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts.</p>"
|
||||
},
|
||||
"InferRxNorm":{
|
||||
"name":"InferRxNorm",
|
||||
|
|
@ -136,7 +136,7 @@
|
|||
{"shape":"InvalidEncodingException"},
|
||||
{"shape":"TextSizeLimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine.</p>"
|
||||
"documentation":"<p>InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.</p>"
|
||||
},
|
||||
"ListEntitiesDetectionV2Jobs":{
|
||||
"name":"ListEntitiesDetectionV2Jobs",
|
||||
|
|
@ -250,6 +250,10 @@
|
|||
"shape":"Float",
|
||||
"documentation":"<p> The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity. </p>"
|
||||
},
|
||||
"RelationshipType":{
|
||||
"shape":"RelationshipType",
|
||||
"documentation":"<p>The type of relationship between the entity and attribute. Type for the relationship is <code>OVERLAP</code>, indicating that the entity occurred at the same time as the <code>Date_Expression</code>. </p>"
|
||||
},
|
||||
"Id":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p> The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier. </p>"
|
||||
|
|
@ -266,6 +270,10 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p> The segment of input text extracted as this attribute.</p>"
|
||||
},
|
||||
"Category":{
|
||||
"shape":"EntityType",
|
||||
"documentation":"<p> The category of attribute. </p>"
|
||||
},
|
||||
"Traits":{
|
||||
"shape":"TraitList",
|
||||
"documentation":"<p> Contextual information for this attribute. </p>"
|
||||
|
|
@ -600,7 +608,13 @@
|
|||
"SYSTEM_ORGAN_SITE",
|
||||
"DIRECTION",
|
||||
"QUALITY",
|
||||
"QUANTITY"
|
||||
"QUANTITY",
|
||||
"TIME_EXPRESSION",
|
||||
"TIME_TO_MEDICATION_NAME",
|
||||
"TIME_TO_DX_NAME",
|
||||
"TIME_TO_TEST_NAME",
|
||||
"TIME_TO_PROCEDURE_NAME",
|
||||
"TIME_TO_TREATMENT_NAME"
|
||||
]
|
||||
},
|
||||
"EntityType":{
|
||||
|
|
@ -610,7 +624,8 @@
|
|||
"MEDICAL_CONDITION",
|
||||
"PROTECTED_HEALTH_INFORMATION",
|
||||
"TEST_TREATMENT_PROCEDURE",
|
||||
"ANATOMY"
|
||||
"ANATOMY",
|
||||
"TIME_EXPRESSION"
|
||||
]
|
||||
},
|
||||
"Float":{"type":"float"},
|
||||
|
|
@ -848,7 +863,7 @@
|
|||
"documentation":"<p>The path to the input data files in the S3 bucket.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input properties for an entities detection job</p>"
|
||||
"documentation":"<p>The input properties for an entities detection job.</p>"
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"InternalServerException":{
|
||||
|
|
@ -1001,6 +1016,28 @@
|
|||
},
|
||||
"documentation":"<p>The output properties for a detection job.</p>"
|
||||
},
|
||||
"RelationshipType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"EVERY",
|
||||
"WITH_DOSAGE",
|
||||
"ADMINISTERED_VIA",
|
||||
"FOR",
|
||||
"NEGATIVE",
|
||||
"OVERLAP",
|
||||
"DOSAGE",
|
||||
"ROUTE_OR_MODE",
|
||||
"FORM",
|
||||
"FREQUENCY",
|
||||
"DURATION",
|
||||
"STRENGTH",
|
||||
"RATE",
|
||||
"ACUITY",
|
||||
"TEST_VALUE",
|
||||
"TEST_UNITS",
|
||||
"DIRECTION"
|
||||
]
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
|
|||
|
|
@ -180,7 +180,8 @@
|
|||
"output":{"shape":"DeleteRemediationConfigurationResponse"},
|
||||
"errors":[
|
||||
{"shape":"NoSuchRemediationConfigurationException"},
|
||||
{"shape":"RemediationInProgressException"}
|
||||
{"shape":"RemediationInProgressException"},
|
||||
{"shape":"InsufficientPermissionsException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the remediation configuration.</p>"
|
||||
},
|
||||
|
|
@ -1056,6 +1057,22 @@
|
|||
],
|
||||
"documentation":"<p>Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information. The API creates the <code>RetentionConfiguration</code> object and names the object as <b>default</b>. When you have a <code>RetentionConfiguration</code> object named <b>default</b>, calling the API modifies the default object. </p> <note> <p>Currently, AWS Config supports only one retention configuration per region in your account.</p> </note>"
|
||||
},
|
||||
"SelectAggregateResourceConfig":{
|
||||
"name":"SelectAggregateResourceConfig",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"SelectAggregateResourceConfigRequest"},
|
||||
"output":{"shape":"SelectAggregateResourceConfigResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidExpressionException"},
|
||||
{"shape":"NoSuchConfigurationAggregatorException"},
|
||||
{"shape":"InvalidLimitException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
],
|
||||
"documentation":"<p>Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of AWS resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.</p> <p>For more information about query components, see the <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/query-components.html\"> <b>Query Components</b> </a> section in the AWS Config Developer Guide.</p>"
|
||||
},
|
||||
"SelectResourceConfig":{
|
||||
"name":"SelectResourceConfig",
|
||||
"http":{
|
||||
|
|
@ -1397,7 +1414,7 @@
|
|||
"AllSupported":{"type":"boolean"},
|
||||
"AmazonResourceName":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"max":1000,
|
||||
"min":1
|
||||
},
|
||||
"Annotation":{
|
||||
|
|
@ -1720,15 +1737,15 @@
|
|||
"required":["Source"],
|
||||
"members":{
|
||||
"ConfigRuleName":{
|
||||
"shape":"StringWithCharLimit64",
|
||||
"shape":"ConfigRuleName",
|
||||
"documentation":"<p>The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.</p>"
|
||||
},
|
||||
"ConfigRuleArn":{
|
||||
"shape":"String",
|
||||
"shape":"StringWithCharLimit256",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Config rule.</p>"
|
||||
},
|
||||
"ConfigRuleId":{
|
||||
"shape":"String",
|
||||
"shape":"StringWithCharLimit64",
|
||||
"documentation":"<p>The ID of the AWS Config rule.</p>"
|
||||
},
|
||||
"Description":{
|
||||
|
|
@ -1809,7 +1826,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigRuleName":{
|
||||
"shape":"StringWithCharLimit64",
|
||||
"shape":"ConfigRuleName",
|
||||
"documentation":"<p>The name of the AWS Config rule.</p>"
|
||||
},
|
||||
"ConfigRuleArn":{
|
||||
|
|
@ -1840,6 +1857,7 @@
|
|||
"shape":"Date",
|
||||
"documentation":"<p>The time that you first activated the AWS Config rule.</p>"
|
||||
},
|
||||
"LastDeactivatedTime":{"shape":"Date"},
|
||||
"LastErrorCode":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The error code that AWS Config returned when the rule last failed.</p>"
|
||||
|
|
@ -2468,7 +2486,7 @@
|
|||
"required":["ConfigRuleName"],
|
||||
"members":{
|
||||
"ConfigRuleName":{
|
||||
"shape":"StringWithCharLimit64",
|
||||
"shape":"ConfigRuleName",
|
||||
"documentation":"<p>The name of the AWS Config rule that you want to delete.</p>"
|
||||
}
|
||||
},
|
||||
|
|
@ -3543,7 +3561,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigRuleName":{
|
||||
"shape":"StringWithCharLimit64",
|
||||
"shape":"ConfigRuleName",
|
||||
"documentation":"<p>The name of the AWS Config rule that was used in the evaluation.</p>"
|
||||
},
|
||||
"ResourceType":{
|
||||
|
|
@ -5532,7 +5550,7 @@
|
|||
},
|
||||
"ReevaluateConfigRuleNames":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StringWithCharLimit64"},
|
||||
"member":{"shape":"ConfigRuleName"},
|
||||
"max":25,
|
||||
"min":1
|
||||
},
|
||||
|
|
@ -5976,6 +5994,7 @@
|
|||
"AWS::EC2::VPCEndpointService",
|
||||
"AWS::EC2::FlowLog",
|
||||
"AWS::EC2::VPCPeeringConnection",
|
||||
"AWS::Elasticsearch::Domain",
|
||||
"AWS::IAM::Group",
|
||||
"AWS::IAM::Policy",
|
||||
"AWS::IAM::Role",
|
||||
|
|
@ -5983,13 +6002,10 @@
|
|||
"AWS::ElasticLoadBalancingV2::LoadBalancer",
|
||||
"AWS::ACM::Certificate",
|
||||
"AWS::RDS::DBInstance",
|
||||
"AWS::RDS::DBParameterGroup",
|
||||
"AWS::RDS::DBOptionGroup",
|
||||
"AWS::RDS::DBSubnetGroup",
|
||||
"AWS::RDS::DBSecurityGroup",
|
||||
"AWS::RDS::DBSnapshot",
|
||||
"AWS::RDS::DBCluster",
|
||||
"AWS::RDS::DBClusterParameterGroup",
|
||||
"AWS::RDS::DBClusterSnapshot",
|
||||
"AWS::RDS::EventSubscription",
|
||||
"AWS::S3::Bucket",
|
||||
|
|
@ -6020,30 +6036,32 @@
|
|||
"AWS::WAFRegional::WebACL",
|
||||
"AWS::CloudFront::Distribution",
|
||||
"AWS::CloudFront::StreamingDistribution",
|
||||
"AWS::Lambda::Alias",
|
||||
"AWS::Lambda::Function",
|
||||
"AWS::ElasticBeanstalk::Application",
|
||||
"AWS::ElasticBeanstalk::ApplicationVersion",
|
||||
"AWS::ElasticBeanstalk::Environment",
|
||||
"AWS::MobileHub::Project",
|
||||
"AWS::WAFv2::WebACL",
|
||||
"AWS::WAFv2::RuleGroup",
|
||||
"AWS::WAFv2::IPSet",
|
||||
"AWS::WAFv2::RegexPatternSet",
|
||||
"AWS::WAFv2::ManagedRuleSet",
|
||||
"AWS::XRay::EncryptionConfig",
|
||||
"AWS::SSM::AssociationCompliance",
|
||||
"AWS::SSM::PatchCompliance",
|
||||
"AWS::Shield::Protection",
|
||||
"AWS::ShieldRegional::Protection",
|
||||
"AWS::Config::ResourceCompliance",
|
||||
"AWS::LicenseManager::LicenseConfiguration",
|
||||
"AWS::ApiGateway::DomainName",
|
||||
"AWS::ApiGateway::Method",
|
||||
"AWS::ApiGateway::Stage",
|
||||
"AWS::ApiGateway::RestApi",
|
||||
"AWS::ApiGatewayV2::DomainName",
|
||||
"AWS::ApiGatewayV2::Stage",
|
||||
"AWS::ApiGatewayV2::Api",
|
||||
"AWS::CodePipeline::Pipeline",
|
||||
"AWS::ServiceCatalog::CloudFormationProvisionedProduct",
|
||||
"AWS::ServiceCatalog::CloudFormationProduct",
|
||||
"AWS::ServiceCatalog::Portfolio"
|
||||
"AWS::ServiceCatalog::Portfolio",
|
||||
"AWS::SQS::Queue",
|
||||
"AWS::KMS::Key",
|
||||
"AWS::QLDB::Ledger"
|
||||
]
|
||||
},
|
||||
"ResourceTypeList":{
|
||||
|
|
@ -6158,6 +6176,46 @@
|
|||
},
|
||||
"documentation":"<p>Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.</p>"
|
||||
},
|
||||
"SelectAggregateResourceConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Expression",
|
||||
"ConfigurationAggregatorName"
|
||||
],
|
||||
"members":{
|
||||
"Expression":{
|
||||
"shape":"Expression",
|
||||
"documentation":"<p>The SQL query SELECT command. </p>"
|
||||
},
|
||||
"ConfigurationAggregatorName":{
|
||||
"shape":"ConfigurationAggregatorName",
|
||||
"documentation":"<p>The name of the configuration aggregator.</p>"
|
||||
},
|
||||
"Limit":{
|
||||
"shape":"Limit",
|
||||
"documentation":"<p>The maximum number of query results returned on each page. </p>"
|
||||
},
|
||||
"MaxResults":{"shape":"Limit"},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The nextToken string returned in a previous request that you use to request the next page of results in a paginated response. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SelectAggregateResourceConfigResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Results":{
|
||||
"shape":"Results",
|
||||
"documentation":"<p>Returns the results for the SQL query.</p>"
|
||||
},
|
||||
"QueryInfo":{"shape":"QueryInfo"},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The nextToken string returned in a previous request that you use to request the next page of results in a paginated response. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SelectResourceConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":["Expression"],
|
||||
|
|
|
|||
|
|
@ -805,10 +805,10 @@
|
|||
"members":{
|
||||
"Name":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the availability zone.</p>"
|
||||
"documentation":"<p>The name of the Availability Zone.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>The name of the Availability Zone for use during database migration.</p>"
|
||||
},
|
||||
"AvailabilityZonesList":{
|
||||
"type":"list",
|
||||
|
|
@ -821,7 +821,7 @@
|
|||
"members":{
|
||||
"CertificateIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A customer-assigned name for the certificate. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
"documentation":"<p>A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
},
|
||||
"CertificateCreationDate":{
|
||||
"shape":"TStamp",
|
||||
|
|
@ -879,11 +879,11 @@
|
|||
"members":{
|
||||
"ReplicationInstanceArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the replication instance.</p>"
|
||||
"documentation":"<p>The ARN of the replication instance.</p>"
|
||||
},
|
||||
"EndpointArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>"
|
||||
"documentation":"<p>The ARN string that uniquely identifies the endpoint.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
|
|
@ -895,14 +895,14 @@
|
|||
},
|
||||
"EndpointIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
"documentation":"<p>The identifier of the endpoint. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
},
|
||||
"ReplicationInstanceIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The replication instance identifier. This parameter is stored as a lowercase string.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.</p>"
|
||||
},
|
||||
"ConnectionList":{
|
||||
"type":"list",
|
||||
|
|
@ -918,7 +918,7 @@
|
|||
"members":{
|
||||
"EndpointIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
"documentation":"<p>The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
},
|
||||
"EndpointType":{
|
||||
"shape":"ReplicationEndpointTypeValue",
|
||||
|
|
@ -926,7 +926,7 @@
|
|||
},
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the <code>EndpointType</code> value, include <code>mysql</code>, <code>oracle</code>, <code>postgres</code>, <code>mariadb</code>, <code>aurora</code>, <code>aurora-postgresql</code>, <code>redshift</code>, <code>s3</code>, <code>db2</code>, <code>azuredb</code>, <code>sybase</code>, <code>dynamodb</code>, <code>mongodb</code>, and <code>sqlserver</code>.</p>"
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the <code>EndpointType</code> value, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, and <code>\"sqlserver\"</code>.</p>"
|
||||
},
|
||||
"Username":{
|
||||
"shape":"String",
|
||||
|
|
@ -978,7 +978,7 @@
|
|||
},
|
||||
"DynamoDbSettings":{
|
||||
"shape":"DynamoDbSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html\">Using Object Mapping to Migrate Data to DynamoDB</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html\">Using Object Mapping to Migrate Data to DynamoDB</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"S3Settings":{
|
||||
"shape":"S3Settings",
|
||||
|
|
@ -990,11 +990,15 @@
|
|||
},
|
||||
"MongoDbSettings":{
|
||||
"shape":"MongoDbSettings",
|
||||
"documentation":"<p>Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html\"> Using MongoDB as a Target for AWS Database Migration Service</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html\">Using MongoDB as a Target for AWS Database Migration Service</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"KinesisSettings":{
|
||||
"shape":"KinesisSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping\">Using Object Mapping to Migrate Data to a Kinesis Data Stream</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For information about other available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping\">Using Object Mapping to Migrate Data to a Kinesis Data Stream</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
},
|
||||
"KafkaSettings":{
|
||||
"shape":"KafkaSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Apache Kafka endpoint. For information about other available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping\">Using Object Mapping to Migrate Data to Apache Kafka</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
},
|
||||
"ElasticsearchSettings":{
|
||||
"shape":"ElasticsearchSettings",
|
||||
|
|
@ -1031,7 +1035,7 @@
|
|||
},
|
||||
"SourceType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to <code>replication-instance</code>. If this value is not specified, all events are returned. </p> <p>Valid values: <code>replication-instance</code> | <code>replication-task</code> </p>"
|
||||
"documentation":"<p> The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to <code>replication-instance</code>. If this value isn't specified, all events are returned. </p> <p>Valid values: <code>replication-instance</code> | <code>replication-task</code> </p>"
|
||||
},
|
||||
"EventCategories":{
|
||||
"shape":"EventCategoriesList",
|
||||
|
|
@ -1071,7 +1075,7 @@
|
|||
"members":{
|
||||
"ReplicationInstanceIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The replication instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>myrepinstance</code> </p>"
|
||||
"documentation":"<p>The replication instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>myrepinstance</code> </p>"
|
||||
},
|
||||
"AllocatedStorage":{
|
||||
"shape":"IntegerOptional",
|
||||
|
|
@ -1087,7 +1091,7 @@
|
|||
},
|
||||
"AvailabilityZone":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's AWS Region, for example: <code>us-east-1d</code> </p>"
|
||||
"documentation":"<p>The Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's AWS Region, for example: <code>us-east-1d</code> </p>"
|
||||
},
|
||||
"ReplicationSubnetGroupIdentifier":{
|
||||
"shape":"String",
|
||||
|
|
@ -1099,7 +1103,7 @@
|
|||
},
|
||||
"MultiAZ":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p> Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>"
|
||||
"documentation":"<p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
|
|
@ -1107,7 +1111,7 @@
|
|||
},
|
||||
"AutoMinorVersionUpgrade":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Indicates whether minor engine upgrades will be applied automatically to the replication instance during the maintenance window. This parameter defaults to <code>true</code>.</p> <p>Default: <code>true</code> </p>"
|
||||
"documentation":"<p>A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. This parameter defaults to <code>true</code>.</p> <p>Default: <code>true</code> </p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -1431,7 +1435,7 @@
|
|||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the vlue specified by <code>MaxRecords</code>. </p>"
|
||||
"documentation":"<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1849,7 +1853,7 @@
|
|||
"members":{
|
||||
"ReplicationTaskArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>- The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified the API will return only one result and ignore the values of the max-records and marker parameters. </p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified, the API returns only one result and ignore the values of the <code>MaxRecords</code> and <code>Marker</code> parameters. </p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"IntegerOptional",
|
||||
|
|
@ -2022,7 +2026,7 @@
|
|||
"documentation":"<p> The Amazon Resource Name (ARN) used by the service access IAM role. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.</p>"
|
||||
},
|
||||
"ElasticsearchSettings":{
|
||||
"type":"structure",
|
||||
|
|
@ -2045,10 +2049,10 @@
|
|||
},
|
||||
"ErrorRetryDuration":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.</p>"
|
||||
"documentation":"<p>The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides information that defines an Elasticsearch endpoint.</p>"
|
||||
},
|
||||
"EncodingTypeValue":{
|
||||
"type":"string",
|
||||
|
|
@ -2070,7 +2074,7 @@
|
|||
"members":{
|
||||
"EndpointIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
"documentation":"<p>The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
},
|
||||
"EndpointType":{
|
||||
"shape":"ReplicationEndpointTypeValue",
|
||||
|
|
@ -2078,7 +2082,7 @@
|
|||
},
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The database engine name. Valid values, depending on the EndpointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.</p>"
|
||||
"documentation":"<p>The database engine name. Valid values, depending on the EndpointType, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, and <code>\"sqlserver\"</code>.</p>"
|
||||
},
|
||||
"EngineDisplayName":{
|
||||
"shape":"String",
|
||||
|
|
@ -2154,7 +2158,11 @@
|
|||
},
|
||||
"KinesisSettings":{
|
||||
"shape":"KinesisSettings",
|
||||
"documentation":"<p>The settings for the Amazon Kinesis source endpoint. For more information, see the <code>KinesisSettings</code> structure.</p>"
|
||||
"documentation":"<p>The settings for the Amazon Kinesis target endpoint. For more information, see the <code>KinesisSettings</code> structure.</p>"
|
||||
},
|
||||
"KafkaSettings":{
|
||||
"shape":"KafkaSettings",
|
||||
"documentation":"<p>The settings for the Apache Kafka target endpoint. For more information, see the <code>KafkaSettings</code> structure.</p>"
|
||||
},
|
||||
"ElasticsearchSettings":{
|
||||
"shape":"ElasticsearchSettings",
|
||||
|
|
@ -2165,7 +2173,7 @@
|
|||
"documentation":"<p>Settings for the Amazon Redshift endpoint.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Describes an endpoint of a database instance in response to operations such as the following:</p> <ul> <li> <p> <code>CreateEndpoint</code> </p> </li> <li> <p> <code>DescribeEndpoint</code> </p> </li> <li> <p> <code>DescribeEndpointTypes</code> </p> </li> <li> <p> <code>ModifyEndpoint</code> </p> </li> </ul>"
|
||||
},
|
||||
"EndpointList":{
|
||||
"type":"list",
|
||||
|
|
@ -2195,7 +2203,7 @@
|
|||
"documentation":"<p>The date of the event.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Describes an identifiable significant activity that affects a replication instance or task. This object can provide the message, the available event categories, the date and source of the event, and the AWS DMS resource type.</p>"
|
||||
},
|
||||
"EventCategoriesList":{
|
||||
"type":"list",
|
||||
|
|
@ -2213,7 +2221,7 @@
|
|||
"documentation":"<p> A list of event categories from a source type that you've chosen.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Lists categories of events subscribed to, and generated by, the applicable AWS DMS resource type.</p>"
|
||||
},
|
||||
"EventCategoryGroupList":{
|
||||
"type":"list",
|
||||
|
|
@ -2263,7 +2271,7 @@
|
|||
"documentation":"<p>Boolean value that indicates if the event subscription is enabled.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Describes an event notification subscription created by the <code>CreateEventSubscription</code> operation.</p>"
|
||||
},
|
||||
"EventSubscriptionsList":{
|
||||
"type":"list",
|
||||
|
|
@ -2286,7 +2294,7 @@
|
|||
"documentation":"<p>The filter value.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Identifies the name and value of a source filter object used to limit the number and type of records transferred from your source to your target.</p>"
|
||||
},
|
||||
"FilterList":{
|
||||
"type":"list",
|
||||
|
|
@ -2302,7 +2310,7 @@
|
|||
"members":{
|
||||
"CertificateIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A customer-assigned name for the certificate. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
"documentation":"<p>A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
},
|
||||
"CertificatePem":{
|
||||
"shape":"String",
|
||||
|
|
@ -2421,6 +2429,20 @@
|
|||
"documentation":"<p>This request triggered AWS KMS request throttling.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"KafkaSettings":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Broker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker in the form <code> <i>broker-hostname-or-ip</i>:<i>port</i> </code>. For example, <code>\"ec2-12-345-678-901.compute-1.amazonaws.com:2345\"</code>.</p>"
|
||||
},
|
||||
"Topic":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies <code>\"kafka-default-topic\"</code> as the migration topic.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides information that describes an Apache Kafka endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.</p>"
|
||||
},
|
||||
"KeyList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
|
|
@ -2434,14 +2456,34 @@
|
|||
},
|
||||
"MessageFormat":{
|
||||
"shape":"MessageFormatValue",
|
||||
"documentation":"<p>The output format for the records created on the endpoint. The message format is <code>JSON</code>.</p>"
|
||||
"documentation":"<p>The output format for the records created on the endpoint. The message format is <code>JSON</code> (default) or <code>JSON_UNFORMATTED</code> (a single line with no tab).</p>"
|
||||
},
|
||||
"ServiceAccessRoleArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that AWS DMS uses to write to the Kinesis data stream.</p>"
|
||||
},
|
||||
"IncludeTransactionDetails":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for <code>transaction_id</code>, previous <code>transaction_id</code>, and <code>transaction_record_id</code> (the record offset within a transaction). The default is <code>False</code>.</p>"
|
||||
},
|
||||
"IncludePartitionValue":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Shows the partition value within the Kinesis message output, unless the partition type is <code>schema-table-type</code>. The default is <code>False</code>.</p>"
|
||||
},
|
||||
"PartitionIncludeSchemaTable":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Prefixes schema and table names to partition values, when the partition type is <code>primary-key-type</code>. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is <code>False</code>.</p>"
|
||||
},
|
||||
"IncludeTableAlterOperations":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Includes any data definition language (DDL) operations that change the table in the control data, such as <code>rename-table</code>, <code>drop-table</code>, <code>add-column</code>, <code>drop-column</code>, and <code>rename-column</code>. The default is <code>False</code>.</p>"
|
||||
},
|
||||
"IncludeControlDetails":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is <code>False</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides information that describes an Amazon Kinesis Data Stream endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.</p>"
|
||||
},
|
||||
"ListTagsForResourceMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -2467,7 +2509,10 @@
|
|||
"Long":{"type":"long"},
|
||||
"MessageFormatValue":{
|
||||
"type":"string",
|
||||
"enum":["json"]
|
||||
"enum":[
|
||||
"json",
|
||||
"json-unformatted"
|
||||
]
|
||||
},
|
||||
"MigrationTypeValue":{
|
||||
"type":"string",
|
||||
|
|
@ -2487,7 +2532,7 @@
|
|||
},
|
||||
"EndpointIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
"documentation":"<p>The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.</p>"
|
||||
},
|
||||
"EndpointType":{
|
||||
"shape":"ReplicationEndpointTypeValue",
|
||||
|
|
@ -2495,7 +2540,7 @@
|
|||
},
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the EndpointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.</p>"
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the EndpointType, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, and <code>\"sqlserver\"</code>.</p>"
|
||||
},
|
||||
"Username":{
|
||||
"shape":"String",
|
||||
|
|
@ -2539,7 +2584,7 @@
|
|||
},
|
||||
"DynamoDbSettings":{
|
||||
"shape":"DynamoDbSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html\">Using Object Mapping to Migrate Data to DynamoDB</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html\">Using Object Mapping to Migrate Data to DynamoDB</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"S3Settings":{
|
||||
"shape":"S3Settings",
|
||||
|
|
@ -2547,7 +2592,7 @@
|
|||
},
|
||||
"DmsTransferSettings":{
|
||||
"shape":"DmsTransferSettings",
|
||||
"documentation":"<p>The settings in JSON format for the DMS transfer type of source endpoint. </p> <p>Attributes include the following:</p> <ul> <li> <p>serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.</p> </li> <li> <p>BucketName - The name of the S3 bucket to use.</p> </li> <li> <p>compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.</p> </li> </ul> <p>Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string</p> <p>JSON syntax:</p> <p> { \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } </p>"
|
||||
"documentation":"<p>The settings in JSON format for the DMS transfer type of source endpoint. </p> <p>Attributes include the following:</p> <ul> <li> <p>serviceAccessRoleArn - The AWS Identity and Access Management (IAM) role that has permission to access the Amazon S3 bucket.</p> </li> <li> <p>BucketName - The name of the S3 bucket to use.</p> </li> <li> <p>compressionType - An optional parameter to use GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed.</p> </li> </ul> <p>Shorthand syntax for these settings is as follows: <code>ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string</code> </p> <p>JSON syntax for these settings is as follows: <code>{ \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } </code> </p>"
|
||||
},
|
||||
"MongoDbSettings":{
|
||||
"shape":"MongoDbSettings",
|
||||
|
|
@ -2555,7 +2600,11 @@
|
|||
},
|
||||
"KinesisSettings":{
|
||||
"shape":"KinesisSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping\">Using Object Mapping to Migrate Data to a Kinesis Data Stream</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For information about other available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html#CHAP_Target.Kinesis.ObjectMapping\">Using Object Mapping to Migrate Data to a Kinesis Data Stream</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
},
|
||||
"KafkaSettings":{
|
||||
"shape":"KafkaSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Apache Kafka endpoint. For information about other available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html#CHAP_Target.Kafka.ObjectMapping\">Using Object Mapping to Migrate Data to Apache Kafka</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
},
|
||||
"ElasticsearchSettings":{
|
||||
"shape":"ElasticsearchSettings",
|
||||
|
|
@ -2642,7 +2691,7 @@
|
|||
},
|
||||
"MultiAZ":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p> Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>"
|
||||
"documentation":"<p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
|
|
@ -2654,7 +2703,7 @@
|
|||
},
|
||||
"AutoMinorVersionUpgrade":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p> Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to <code>true</code> during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version. </p>"
|
||||
"documentation":"<p>A value that indicates that minor version upgrades are applied automatically to the replication instance during the maintenance window. Changing this parameter doesn't result in an outage, except in the case dsecribed following. The change is asynchronously applied as soon as possible. </p> <p>An outage does result if these factors apply: </p> <ul> <li> <p>This parameter is set to <code>true</code> during the maintenance window.</p> </li> <li> <p>A newer minor version is available. </p> </li> <li> <p>AWS DMS has enabled automatic patching for the given engine version. </p> </li> </ul>"
|
||||
},
|
||||
"ReplicationInstanceIdentifier":{
|
||||
"shape":"String",
|
||||
|
|
@ -2783,7 +2832,7 @@
|
|||
},
|
||||
"AuthMechanism":{
|
||||
"shape":"AuthMechanismValue",
|
||||
"documentation":"<p> The authentication mechanism you use to access the MongoDB source endpoint.</p> <p>Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 </p> <p>DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This setting is not used when authType=No.</p>"
|
||||
"documentation":"<p> The authentication mechanism you use to access the MongoDB source endpoint.</p> <p>Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 </p> <p>DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This setting isn't used when authType=No.</p>"
|
||||
},
|
||||
"NestingLevel":{
|
||||
"shape":"NestingLevelValue",
|
||||
|
|
@ -2799,14 +2848,14 @@
|
|||
},
|
||||
"AuthSource":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The MongoDB database name. This setting is not used when <code>authType=NO</code>. </p> <p>The default is admin.</p>"
|
||||
"documentation":"<p> The MongoDB database name. This setting isn't used when <code>authType=NO</code>. </p> <p>The default is admin.</p>"
|
||||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the <code>KmsKeyId</code> parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides information that defines a MongoDB endpoint.</p>"
|
||||
},
|
||||
"NestingLevelValue":{
|
||||
"type":"string",
|
||||
|
|
@ -2855,7 +2904,7 @@
|
|||
"documentation":"<p>The value returned when the specified <code>EngineVersion</code> of the replication instance is in Beta or test mode. This indicates some features might not work as expected.</p> <note> <p>AWS DMS supports the <code>ReleaseStatus</code> parameter in versions 3.1.4 and later.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>In response to the <code>DescribeOrderableReplicationInstances</code> operation, this object describes an available replication instance. This description includes the replication instance's type, engine version, and allocated storage.</p>"
|
||||
},
|
||||
"OrderableReplicationInstanceList":{
|
||||
"type":"list",
|
||||
|
|
@ -2877,26 +2926,26 @@
|
|||
},
|
||||
"AutoAppliedAfterDate":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any <code>next-maintenance</code> opt-in requests are ignored.</p>"
|
||||
"documentation":"<p>The date of the maintenance window when the action is to be applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any <code>next-maintenance</code> opt-in requests are ignored.</p>"
|
||||
},
|
||||
"ForcedApplyDate":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any <code>immediate</code> opt-in requests are ignored.</p>"
|
||||
"documentation":"<p>The date when the maintenance action will be automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any <code>immediate</code> opt-in requests are ignored.</p>"
|
||||
},
|
||||
"OptInStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Indicates the type of opt-in request that has been received for the resource.</p>"
|
||||
"documentation":"<p>The type of opt-in request that has been received for the resource.</p>"
|
||||
},
|
||||
"CurrentApplyDate":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the <code>ApplyPendingMaintenanceAction</code> API, the <code>AutoAppliedAfterDate</code>, and the <code>ForcedApplyDate</code>. This value is blank if an opt-in request has not been received and nothing has been specified as <code>AutoAppliedAfterDate</code> or <code>ForcedApplyDate</code>.</p>"
|
||||
"documentation":"<p>The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the <code>ApplyPendingMaintenanceAction</code> API operation, and also the <code>AutoAppliedAfterDate</code> and <code>ForcedApplyDate</code> parameter values. This value is blank if an opt-in request has not been received and nothing has been specified for <code>AutoAppliedAfterDate</code> or <code>ForcedApplyDate</code>.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description providing more detail about the maintenance action.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Describes a maintenance action pending for an AWS DMS resource, including when and how it will be applied. This data type is a response element to the <code>DescribePendingMaintenanceActions</code> operation.</p>"
|
||||
},
|
||||
"PendingMaintenanceActionDetails":{
|
||||
"type":"list",
|
||||
|
|
@ -3033,7 +3082,7 @@
|
|||
"documentation":"<p>The size of the write buffer to use in rows. Valid values range from 1 through 2,048. The default is 1,024. Use this setting to tune performance. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides information that defines an Amazon Redshift endpoint.</p>"
|
||||
},
|
||||
"RefreshSchemasMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -3087,7 +3136,7 @@
|
|||
"documentation":"<p>The last failure message for the schema.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides information that describes status of a schema at an endpoint specified by the <code>DescribeRefreshSchemaStatus</code> operation.</p>"
|
||||
},
|
||||
"RefreshSchemasStatusTypeValue":{
|
||||
"type":"string",
|
||||
|
|
@ -3214,7 +3263,7 @@
|
|||
},
|
||||
"MultiAZ":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p> Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>"
|
||||
"documentation":"<p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
|
|
@ -3256,7 +3305,7 @@
|
|||
},
|
||||
"SecondaryAvailabilityZone":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The availability zone of the standby replication instance in a Multi-AZ deployment.</p>"
|
||||
"documentation":"<p>The Availability Zone of the standby replication instance in a Multi-AZ deployment.</p>"
|
||||
},
|
||||
"FreeUntil":{
|
||||
"shape":"TStamp",
|
||||
|
|
@ -3267,7 +3316,7 @@
|
|||
"documentation":"<p>The DNS name servers for the replication instance.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides information that defines a replication instance.</p>"
|
||||
},
|
||||
"ReplicationInstanceList":{
|
||||
"type":"list",
|
||||
|
|
@ -3316,14 +3365,14 @@
|
|||
},
|
||||
"MultiAZ":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p> Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>"
|
||||
"documentation":"<p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The engine version number of the replication instance.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides information about the values of pending modifications to a replication instance. This data type is an object of the <code>ReplicationInstance</code> user-defined data type. </p>"
|
||||
},
|
||||
"ReplicationSubnetGroup":{
|
||||
"type":"structure",
|
||||
|
|
@ -3349,7 +3398,7 @@
|
|||
"documentation":"<p>The subnets that are in the subnet group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Describes a subnet group in response to a request by the <code>DescribeReplicationSubnetGroup</code> operation.</p>"
|
||||
},
|
||||
"ReplicationSubnetGroupDoesNotCoverEnoughAZs":{
|
||||
"type":"structure",
|
||||
|
|
@ -3438,7 +3487,7 @@
|
|||
"documentation":"<p>The statistics for the task, including elapsed time, tables loaded, and table errors.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides information that describes a replication task created by the <code>CreateReplicationTask</code> operation.</p>"
|
||||
},
|
||||
"ReplicationTaskAssessmentResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -3523,14 +3572,14 @@
|
|||
},
|
||||
"FullLoadStartDate":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The date the the replication task full load was started.</p>"
|
||||
"documentation":"<p>The date the replication task full load was started.</p>"
|
||||
},
|
||||
"FullLoadFinishDate":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The date the replication task full load was completed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>In response to a request by the <code>DescribeReplicationTasks</code> operation, this object provides a collection of statistics about a replication task.</p>"
|
||||
},
|
||||
"ResourceAlreadyExistsFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -3568,7 +3617,7 @@
|
|||
"documentation":"<p>Detailed information about the pending maintenance action.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Identifies an AWS DMS resource and any pending actions for it.</p>"
|
||||
},
|
||||
"ResourceQuotaExceededFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -3602,7 +3651,7 @@
|
|||
},
|
||||
"BucketFolder":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <code> <i>bucketFolder</i>/<i>schema_name</i>/<i>table_name</i>/</code>. If this parameter is not specified, then the path used is <code> <i>schema_name</i>/<i>table_name</i>/</code>. </p>"
|
||||
"documentation":"<p> An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <code> <i>bucketFolder</i>/<i>schema_name</i>/<i>table_name</i>/</code>. If this parameter isn't specified, then the path used is <code> <i>schema_name</i>/<i>table_name</i>/</code>. </p>"
|
||||
},
|
||||
"BucketName":{
|
||||
"shape":"String",
|
||||
|
|
@ -3610,7 +3659,7 @@
|
|||
},
|
||||
"CompressionType":{
|
||||
"shape":"CompressionTypeValue",
|
||||
"documentation":"<p> An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both .csv and .parquet file formats. </p>"
|
||||
"documentation":"<p>An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Either set this parameter to NONE (the default) or don't use it to leave the files uncompressed. This parameter applies to both .csv and .parquet file formats. </p>"
|
||||
},
|
||||
"EncryptionMode":{
|
||||
"shape":"EncryptionModeValue",
|
||||
|
|
@ -3650,11 +3699,11 @@
|
|||
},
|
||||
"IncludeOpForFullLoad":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.</p> <note> <p>AWS DMS supports the <code>IncludeOpForFullLoad</code> parameter in versions 3.1.4 and later.</p> </note> <p>For full load, records can only be inserted. By default (the <code>false</code> setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If <code>IncludeOpForFullLoad</code> is set to <code>true</code> or <code>y</code>, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.</p> <note> <p>This setting works together with the <code>CdcInsertsOnly</code> parameter for output to .csv files only. For more information about how these settings work together, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps\">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>AWS Database Migration Service User Guide.</i>.</p> </note>"
|
||||
"documentation":"<p>A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.</p> <note> <p>AWS DMS supports the <code>IncludeOpForFullLoad</code> parameter in versions 3.1.4 and later.</p> </note> <p>For full load, records can only be inserted. By default (the <code>false</code> setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If <code>IncludeOpForFullLoad</code> is set to <code>true</code> or <code>y</code>, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.</p> <note> <p>This setting works together with the <code>CdcInsertsOnly</code> and the <code>CdcInsertsAndUpdates</code> parameters for output to .csv files only. For more information about how these settings work together, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps\">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>AWS Database Migration Service User Guide.</i>.</p> </note>"
|
||||
},
|
||||
"CdcInsertsOnly":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the <code>false</code> setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.</p> <p>If <code>CdcInsertsOnly</code> is set to <code>true</code> or <code>y</code>, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of <code>IncludeOpForFullLoad</code>. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If <code>IncludeOpForFullLoad</code> is set to <code>false</code>, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps\">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>AWS Database Migration Service User Guide.</i>.</p> <note> <p>AWS DMS supports this interaction between the <code>CdcInsertsOnly</code> and <code>IncludeOpForFullLoad</code> parameters in versions 3.1.4 and later. </p> </note>"
|
||||
"documentation":"<p>A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the <code>false</code> setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.</p> <p>If <code>CdcInsertsOnly</code> is set to <code>true</code> or <code>y</code>, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of <code>IncludeOpForFullLoad</code>. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If <code>IncludeOpForFullLoad</code> is set to <code>false</code>, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps\">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>AWS Database Migration Service User Guide.</i>.</p> <note> <p>AWS DMS supports the interaction described preceding between the <code>CdcInsertsOnly</code> and <code>IncludeOpForFullLoad</code> parameters in versions 3.1.4 and later. </p> <p> <code>CdcInsertsOnly</code> and <code>CdcInsertsAndUpdates</code> can't both be set to <code>true</code> for the same endpoint. Set either <code>CdcInsertsOnly</code> or <code>CdcInsertsAndUpdates</code> to <code>true</code> for the same endpoint, but not both.</p> </note>"
|
||||
},
|
||||
"TimestampColumnName":{
|
||||
"shape":"String",
|
||||
|
|
@ -3663,6 +3712,10 @@
|
|||
"ParquetTimestampInMillisecond":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that specifies the precision of any <code>TIMESTAMP</code> column values that are written to an Amazon S3 object file in .parquet format.</p> <note> <p>AWS DMS supports the <code>ParquetTimestampInMillisecond</code> parameter in versions 3.1.4 and later.</p> </note> <p>When <code>ParquetTimestampInMillisecond</code> is set to <code>true</code> or <code>y</code>, AWS DMS writes all <code>TIMESTAMP</code> columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.</p> <p>Currently, Amazon Athena and AWS Glue can handle only millisecond precision for <code>TIMESTAMP</code> values. Set this parameter to <code>true</code> for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue.</p> <note> <p>AWS DMS writes any <code>TIMESTAMP</code> column values written to an S3 file in .csv format with microsecond precision.</p> <p>Setting <code>ParquetTimestampInMillisecond</code> has no effect on the string format of the timestamp column value that is inserted by setting the <code>TimestampColumnName</code> parameter.</p> </note>"
|
||||
},
|
||||
"CdcInsertsAndUpdates":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that enables a change data capture (CDC) load to write INSERT and UPDATE operations to .csv or .parquet (columnar storage) output files. The default setting is <code>false</code>, but when <code>CdcInsertsAndUpdates</code> is set to <code>true</code>or <code>y</code>, INSERTs and UPDATEs from the source database are migrated to the .csv or .parquet file. </p> <p>For .csv file format only, how these INSERTs and UPDATEs are recorded depends on the value of the <code>IncludeOpForFullLoad</code> parameter. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to either <code>I</code> or <code>U</code> to indicate INSERT and UPDATE operations at the source. But if <code>IncludeOpForFullLoad</code> is set to <code>false</code>, CDC records are written without an indication of INSERT or UPDATE operations at the source. For more information about how these settings work together, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps\">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>AWS Database Migration Service User Guide.</i>.</p> <note> <p>AWS DMS supports the use of the <code>CdcInsertsAndUpdates</code> parameter in versions 3.3.1 and later.</p> <p> <code>CdcInsertsOnly</code> and <code>CdcInsertsAndUpdates</code> can't both be set to <code>true</code> for the same endpoint. Set either <code>CdcInsertsOnly</code> or <code>CdcInsertsAndUpdates</code> to <code>true</code> for the same endpoint, but not both.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Settings for exporting data to Amazon S3. </p>"
|
||||
|
|
@ -3823,7 +3876,7 @@
|
|||
"documentation":"<p>The status of the subnet.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>In response to a request by the <code>DescribeReplicationSubnetGroup</code> operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.</p>"
|
||||
},
|
||||
"SubnetAlreadyInUse":{
|
||||
"type":"structure",
|
||||
|
|
@ -3849,7 +3902,7 @@
|
|||
"members":{
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The database engine name. Valid values, depending on the EndpointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.</p>"
|
||||
"documentation":"<p>The database engine name. Valid values, depending on the EndpointType, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, and <code>\"sqlserver\"</code>.</p>"
|
||||
},
|
||||
"SupportsCDC":{
|
||||
"shape":"Boolean",
|
||||
|
|
@ -3864,7 +3917,7 @@
|
|||
"documentation":"<p>The expanded name for the engine name. For example, if the <code>EngineName</code> parameter is \"aurora,\" this value would be \"Amazon Aurora MySQL.\"</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides information about types of supported endpoints in response to a request by the <code>DescribeEndpointTypes</code> operation. This information includes the type of endpoint, the database engine name, and whether change data capture (CDC) is supported.</p>"
|
||||
},
|
||||
"SupportedEndpointTypeList":{
|
||||
"type":"list",
|
||||
|
|
@ -3900,23 +3953,35 @@
|
|||
},
|
||||
"Ddls":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The Data Definition Language (DDL) used to build and modify the structure of your tables.</p>"
|
||||
"documentation":"<p>The data definition language (DDL) used to build and modify the structure of your tables.</p>"
|
||||
},
|
||||
"FullLoadRows":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The number of rows added during the Full Load operation.</p>"
|
||||
"documentation":"<p>The number of rows added during the full load operation.</p>"
|
||||
},
|
||||
"FullLoadCondtnlChkFailedRows":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a target migrations).</p>"
|
||||
"documentation":"<p>The number of rows that failed conditional checks during the full load operation (valid only for migrations where DynamoDB is the target).</p>"
|
||||
},
|
||||
"FullLoadErrorRows":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).</p>"
|
||||
"documentation":"<p>The number of rows that failed to load during the full load operation (valid only for migrations where DynamoDB is the target).</p>"
|
||||
},
|
||||
"FullLoadStartTime":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The time when the full load operation started.</p>"
|
||||
},
|
||||
"FullLoadEndTime":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The time when the full load operation completed.</p>"
|
||||
},
|
||||
"FullLoadReloaded":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that indicates if the table was reloaded (<code>true</code>) or loaded as part of a new full load operation (<code>false</code>).</p>"
|
||||
},
|
||||
"LastUpdateTime":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The last time the table was updated.</p>"
|
||||
"documentation":"<p>The last time a table was updated.</p>"
|
||||
},
|
||||
"TableState":{
|
||||
"shape":"String",
|
||||
|
|
@ -3932,18 +3997,18 @@
|
|||
},
|
||||
"ValidationSuspendedRecords":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The number of records that could not be validated.</p>"
|
||||
"documentation":"<p>The number of records that couldn't be validated.</p>"
|
||||
},
|
||||
"ValidationState":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The validation state of the table.</p> <p>The parameter can have the following values</p> <ul> <li> <p>Not enabled—Validation is not enabled for the table in the migration task.</p> </li> <li> <p>Pending records—Some records in the table are waiting for validation.</p> </li> <li> <p>Mismatched records—Some records in the table do not match between the source and target.</p> </li> <li> <p>Suspended records—Some records in the table could not be validated.</p> </li> <li> <p>No primary key—The table could not be validated because it had no primary key.</p> </li> <li> <p>Table error—The table was not validated because it was in an error state and some data was not migrated.</p> </li> <li> <p>Validated—All rows in the table were validated. If the table is updated, the status can change from Validated.</p> </li> <li> <p>Error—The table could not be validated because of an unexpected error.</p> </li> </ul>"
|
||||
"documentation":"<p>The validation state of the table.</p> <p>This parameter can have the following values:</p> <ul> <li> <p>Not enabled - Validation isn't enabled for the table in the migration task.</p> </li> <li> <p>Pending records - Some records in the table are waiting for validation.</p> </li> <li> <p>Mismatched records - Some records in the table don't match between the source and target.</p> </li> <li> <p>Suspended records - Some records in the table couldn't be validated.</p> </li> <li> <p>No primary key - The table couldn't be validated because it has no primary key.</p> </li> <li> <p>Table error - The table wasn't validated because it's in an error state and some data wasn't migrated.</p> </li> <li> <p>Validated - All rows in the table are validated. If the table is updated, the status can change from Validated.</p> </li> <li> <p>Error - The table couldn't be validated because of an unexpected error.</p> </li> </ul>"
|
||||
},
|
||||
"ValidationStateDetails":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Additional details about the state of validation.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides a collection of table statistics in response to a request by the <code>DescribeTableStatistics</code> operation.</p>"
|
||||
},
|
||||
"TableStatisticsList":{
|
||||
"type":"list",
|
||||
|
|
@ -3961,21 +4026,21 @@
|
|||
"documentation":"<p>The table name of the table to be reloaded.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Provides the name of the schema and table to be reloaded.</p>"
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Key":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
|
||||
"documentation":"<p>A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
|
||||
"documentation":"<p>A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:</p> <ul> <li> <p> <code>AddTagsToResource</code> </p> </li> <li> <p> <code>ListTagsForResource</code> </p> </li> <li> <p> <code>RemoveTagsFromResource</code> </p> </li> </ul>"
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
|
|
@ -4036,7 +4101,7 @@
|
|||
"documentation":"<p>The status of the VPC security group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>Describes status of a security group associated with the virtual private cloud hosting your replication and DB instances.</p>"
|
||||
},
|
||||
"VpcSecurityGroupMembershipList":{
|
||||
"type":"list",
|
||||
|
|
|
|||
|
|
@ -299,7 +299,7 @@
|
|||
"errors":[
|
||||
{"shape":"CertificateNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the <code>filterName=engine,Values=docdb</code> filter parameter to return only Amazon DocumentDB clusters.</p>"
|
||||
"documentation":"<p>Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.</p>"
|
||||
},
|
||||
"DescribeDBClusterParameterGroups":{
|
||||
"name":"DescribeDBClusterParameterGroups",
|
||||
|
|
@ -379,7 +379,7 @@
|
|||
"errors":[
|
||||
{"shape":"DBClusterNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination.</p>"
|
||||
"documentation":"<p>Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the <code>filterName=engine,Values=docdb</code> filter parameter to return only Amazon DocumentDB clusters.</p>"
|
||||
},
|
||||
"DescribeDBEngineVersions":{
|
||||
"name":"DescribeDBEngineVersions",
|
||||
|
|
@ -1130,7 +1130,7 @@
|
|||
"members":{
|
||||
"DBClusterParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul> <note> <p>This value is stored as a lowercase string.</p> </note>"
|
||||
"documentation":"<p>The name of the cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must not match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul> <note> <p>This value is stored as a lowercase string.</p> </note>"
|
||||
},
|
||||
"DBParameterGroupFamily":{
|
||||
"shape":"String",
|
||||
|
|
|
|||
|
|
@ -1236,6 +1236,10 @@
|
|||
"State":{
|
||||
"shape":"CertificateState",
|
||||
"documentation":"<p>The state of the certificate.</p>"
|
||||
},
|
||||
"ExpiryDateTime":{
|
||||
"shape":"CertificateExpiryDateTime",
|
||||
"documentation":"<p>The date and time when the certificate will expire.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains general information about a certificate.</p>"
|
||||
|
|
@ -2007,7 +2011,7 @@
|
|||
},
|
||||
"Type":{
|
||||
"shape":"LDAPSType",
|
||||
"documentation":"<p>The type of LDAP security the customer wants to enable, either server or client. Currently supports only <code>Client</code>, (the default).</p>"
|
||||
"documentation":"<p>The type of LDAP security to enable. Currently only the value <code>Client</code> is supported.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
|
|
@ -2510,7 +2514,7 @@
|
|||
},
|
||||
"Type":{
|
||||
"shape":"LDAPSType",
|
||||
"documentation":"<p>The type of LDAP security that the customer wants to enable. The security can be either server or client, but currently only the default <code>Client</code> is supported.</p>"
|
||||
"documentation":"<p>The type of LDAP security to enable. Currently only the value <code>Client</code> is supported.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2658,7 +2662,7 @@
|
|||
},
|
||||
"Type":{
|
||||
"shape":"LDAPSType",
|
||||
"documentation":"<p>The type of LDAP security the customer wants to enable. The security can be either server or client, but currently only the default <code>Client</code> is supported.</p>"
|
||||
"documentation":"<p>The type of LDAP security to enable. Currently only the value <code>Client</code> is supported.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -2814,7 +2814,7 @@
|
|||
},
|
||||
"Limit":{
|
||||
"shape":"PositiveIntegerObject",
|
||||
"documentation":"<p>The maximum number of table names to return.</p>"
|
||||
"documentation":"<p>The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.</p> <p>If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point, with a table name in the <code>LastEvaluatedGlobalTableName</code> to apply in a subsequent operation to the <code>ExclusiveStartGlobalTableName</code> parameter.</p>"
|
||||
},
|
||||
"RegionName":{
|
||||
"shape":"RegionName",
|
||||
|
|
@ -3823,6 +3823,10 @@
|
|||
"ProvisionedThroughputOverride":{
|
||||
"shape":"ProvisionedThroughput",
|
||||
"documentation":"<p>Provisioned throughput settings for the restored table.</p>"
|
||||
},
|
||||
"SSESpecificationOverride":{
|
||||
"shape":"SSESpecification",
|
||||
"documentation":"<p>The new server-side encryption settings for the restored table.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3837,11 +3841,12 @@
|
|||
},
|
||||
"RestoreTableToPointInTimeInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SourceTableName",
|
||||
"TargetTableName"
|
||||
],
|
||||
"required":["TargetTableName"],
|
||||
"members":{
|
||||
"SourceTableArn":{
|
||||
"shape":"TableArn",
|
||||
"documentation":"<p>The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).</p>"
|
||||
},
|
||||
"SourceTableName":{
|
||||
"shape":"TableName",
|
||||
"documentation":"<p>Name of the source table that is being restored.</p>"
|
||||
|
|
@ -3873,6 +3878,10 @@
|
|||
"ProvisionedThroughputOverride":{
|
||||
"shape":"ProvisionedThroughput",
|
||||
"documentation":"<p>Provisioned throughput settings for the restored table.</p>"
|
||||
},
|
||||
"SSESpecificationOverride":{
|
||||
"shape":"SSESpecification",
|
||||
"documentation":"<p>The new server-side encryption settings for the restored table.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -439,6 +439,90 @@
|
|||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "Ipv6CidrAssociations"
|
||||
},
|
||||
"DescribeCoipPools": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "CoipPools"
|
||||
},
|
||||
"DescribeInstanceTypeOfferings": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "InstanceTypeOfferings"
|
||||
},
|
||||
"DescribeInstanceTypes": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "InstanceTypes"
|
||||
},
|
||||
"DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "LocalGatewayRouteTableVirtualInterfaceGroupAssociations"
|
||||
},
|
||||
"DescribeLocalGatewayRouteTableVpcAssociations": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "LocalGatewayRouteTableVpcAssociations"
|
||||
},
|
||||
"DescribeLocalGatewayRouteTables": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "LocalGatewayRouteTables"
|
||||
},
|
||||
"DescribeLocalGatewayVirtualInterfaceGroups": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "LocalGatewayVirtualInterfaceGroups"
|
||||
},
|
||||
"DescribeLocalGatewayVirtualInterfaces": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "LocalGatewayVirtualInterfaces"
|
||||
},
|
||||
"DescribeLocalGateways": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "LocalGateways"
|
||||
},
|
||||
"DescribeTransitGatewayMulticastDomains": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "TransitGatewayMulticastDomains"
|
||||
},
|
||||
"DescribeTransitGatewayPeeringAttachments": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "TransitGatewayPeeringAttachments"
|
||||
},
|
||||
"GetTransitGatewayMulticastDomainAssociations": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "MulticastDomainAssociations"
|
||||
},
|
||||
"SearchLocalGatewayRoutes": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "Routes"
|
||||
},
|
||||
"SearchTransitGatewayMulticastGroups": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "MulticastGroups"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -337,7 +337,7 @@
|
|||
{"shape":"InvalidPolicyException"},
|
||||
{"shape":"IncorrectFileSystemLifeCycleState"}
|
||||
],
|
||||
"documentation":"<p>Applies an Amazon EFS <code>FileSystemPolicy</code> to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html\">Using Resource-based Policies with EFS</a>. </p> <p>This operation requires permissions for the <code>elasticfilesystem:PutFileSystemPolicy</code> action.</p>"
|
||||
"documentation":"<p>Applies an Amazon EFS <code>FileSystemPolicy</code> to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy\">Default EFS File System Policy</a>. </p> <p>This operation requires permissions for the <code>elasticfilesystem:PutFileSystemPolicy</code> action.</p>"
|
||||
},
|
||||
"PutLifecycleConfiguration":{
|
||||
"name":"PutLifecycleConfiguration",
|
||||
|
|
@ -568,7 +568,7 @@
|
|||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"KmsKeyId",
|
||||
"documentation":"<p>The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:</p> <ul> <li> <p>Key ID - A unique identifier of the key, for example <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>ARN - An Amazon Resource Name (ARN) for the key, for example <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>Key alias - A previously created display name for a key, for example <code>alias/projectKey1</code>.</p> </li> <li> <p>Key alias ARN - An ARN for a key alias, for example <code>arn:aws:kms:us-west-2:444455556666:alias/projectKey1</code>.</p> </li> </ul> <p>If <code>KmsKeyId</code> is specified, the <a>CreateFileSystemRequest$Encrypted</a> parameter must be set to true.</p>"
|
||||
"documentation":"<p>The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:</p> <ul> <li> <p>Key ID - A unique identifier of the key, for example <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>ARN - An Amazon Resource Name (ARN) for the key, for example <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>Key alias - A previously created display name for a key, for example <code>alias/projectKey1</code>.</p> </li> <li> <p>Key alias ARN - An ARN for a key alias, for example <code>arn:aws:kms:us-west-2:444455556666:alias/projectKey1</code>.</p> </li> </ul> <p>If <code>KmsKeyId</code> is specified, the <a>CreateFileSystemRequest$Encrypted</a> parameter must be set to true.</p> <important> <p>EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.</p> </important>"
|
||||
},
|
||||
"ThroughputMode":{
|
||||
"shape":"ThroughputMode",
|
||||
|
|
|
|||
|
|
@ -495,6 +495,10 @@
|
|||
"tags":{
|
||||
"shape":"TagMap",
|
||||
"documentation":"<p>The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster. </p>"
|
||||
},
|
||||
"encryptionConfig":{
|
||||
"shape":"EncryptionConfigList",
|
||||
"documentation":"<p>The encryption configuration for the cluster.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An object representing an Amazon EKS cluster.</p>"
|
||||
|
|
@ -551,6 +555,10 @@
|
|||
"tags":{
|
||||
"shape":"TagMap",
|
||||
"documentation":"<p>The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.</p>"
|
||||
},
|
||||
"encryptionConfig":{
|
||||
"shape":"EncryptionConfigList",
|
||||
"documentation":"<p>The encryption configuration for the cluster.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -890,6 +898,25 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"EncryptionConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"resources":{
|
||||
"shape":"StringList",
|
||||
"documentation":"<p>Specifies the resources to be encrypted. The only supported value is \"secrets\".</p>"
|
||||
},
|
||||
"provider":{
|
||||
"shape":"Provider",
|
||||
"documentation":"<p>AWS Key Management Service (AWS KMS) customer master key (CMK). Either the ARN or the alias can be used.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The encryption configuration for the cluster.</p>"
|
||||
},
|
||||
"EncryptionConfigList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"EncryptionConfig"},
|
||||
"max":1
|
||||
},
|
||||
"ErrorCode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -1481,6 +1508,16 @@
|
|||
},
|
||||
"documentation":"<p>An object representing the <a href=\"https://openid.net/connect/\">OpenID Connect</a> identity provider information for the cluster.</p>"
|
||||
},
|
||||
"Provider":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"keyArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Amazon Resource Name (ARN) or alias of the customer master key (CMK). The CMK must be symmetric, created in the same region as the cluster, and if the CMK was created in a different account, the user must have access to the CMK. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html\">Allowing Users in Other Accounts to Use a CMK</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Identifies the AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the secrets.</p>"
|
||||
},
|
||||
"RemoteAccessConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
|
|||
|
|
@ -83,6 +83,12 @@
|
|||
"limit_key": "MaxRecords",
|
||||
"output_token": "Marker",
|
||||
"result_key": "UpdateActions"
|
||||
},
|
||||
"DescribeGlobalReplicationGroups": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"output_token": "Marker",
|
||||
"result_key": "GlobalReplicationGroups"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -210,6 +210,26 @@
|
|||
],
|
||||
"documentation":"<p>Creates a new cache subnet group.</p> <p>Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).</p>"
|
||||
},
|
||||
"CreateGlobalReplicationGroup":{
|
||||
"name":"CreateGlobalReplicationGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateGlobalReplicationGroupMessage"},
|
||||
"output":{
|
||||
"shape":"CreateGlobalReplicationGroupResult",
|
||||
"resultWrapper":"CreateGlobalReplicationGroupResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"ReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidReplicationGroupStateFault"},
|
||||
{"shape":"GlobalReplicationGroupAlreadyExistsFault"},
|
||||
{"shape":"ServiceLinkedRoleNotFoundFault"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>Global Datastore for Redis offers fully managed, fast, reliable and secure cross-region replication. Using Global Datastore for Redis, you can create cross-region read replica clusters for ElastiCache for Redis to enable low-latency reads and disaster recovery across regions. For more information, see <a href=\"/AmazonElastiCache/latest/red-ug/Redis-Global-Clusters.html\">Replication Across Regions Using Global Datastore</a>. </p> <ul> <li> <p>The <b>GlobalReplicationGroupId</b> is the name of the Global Datastore.</p> </li> <li> <p>The <b>PrimaryReplicationGroupId</b> represents the name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.</p> </li> </ul>"
|
||||
},
|
||||
"CreateReplicationGroup":{
|
||||
"name":"CreateReplicationGroup",
|
||||
"http":{
|
||||
|
|
@ -235,10 +255,12 @@
|
|||
{"shape":"InvalidVPCNetworkStateFault"},
|
||||
{"shape":"TagQuotaPerResourceExceeded"},
|
||||
{"shape":"NodeGroupsPerReplicationGroupQuotaExceededFault"},
|
||||
{"shape":"GlobalReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidGlobalReplicationGroupStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p> <p>A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.</p> <p>A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).</p> <p>When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-restoring.html\">Restoring From a Backup with Cluster Resizing</a> in the <i>ElastiCache User Guide</i>.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
"documentation":"<p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p> <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore.</p> <p>A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.</p> <p>A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).</p> <p>When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-restoring.html\">Restoring From a Backup with Cluster Resizing</a> in the <i>ElastiCache User Guide</i>.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"CreateSnapshot":{
|
||||
"name":"CreateSnapshot",
|
||||
|
|
@ -264,6 +286,25 @@
|
|||
],
|
||||
"documentation":"<p>Creates a copy of an entire cluster or replication group at a specific moment in time.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"DecreaseNodeGroupsInGlobalReplicationGroup":{
|
||||
"name":"DecreaseNodeGroupsInGlobalReplicationGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DecreaseNodeGroupsInGlobalReplicationGroupMessage"},
|
||||
"output":{
|
||||
"shape":"DecreaseNodeGroupsInGlobalReplicationGroupResult",
|
||||
"resultWrapper":"DecreaseNodeGroupsInGlobalReplicationGroupResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"GlobalReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidGlobalReplicationGroupStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Decreases the number of node groups in a Global Datastore</p>"
|
||||
},
|
||||
"DecreaseReplicaCount":{
|
||||
"name":"DecreaseReplicaCount",
|
||||
"http":{
|
||||
|
|
@ -289,7 +330,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.</p>"
|
||||
"documentation":"<p>Dynamically decreases the number of replicas in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.</p>"
|
||||
},
|
||||
"DeleteCacheCluster":{
|
||||
"name":"DeleteCacheCluster",
|
||||
|
|
@ -356,6 +397,24 @@
|
|||
],
|
||||
"documentation":"<p>Deletes a cache subnet group.</p> <note> <p>You cannot delete a cache subnet group if it is associated with any clusters.</p> </note>"
|
||||
},
|
||||
"DeleteGlobalReplicationGroup":{
|
||||
"name":"DeleteGlobalReplicationGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteGlobalReplicationGroupMessage"},
|
||||
"output":{
|
||||
"shape":"DeleteGlobalReplicationGroupResult",
|
||||
"resultWrapper":"DeleteGlobalReplicationGroupResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"GlobalReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidGlobalReplicationGroupStateFault"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>Deleting a Global Datastore is a two-step process: </p> <ul> <li> <p>First, you must <a>DisassociateGlobalReplicationGroup</a> to remove the secondary clusters in the Global Datastore.</p> </li> <li> <p>Once the Global Datastore contains only the primary cluster, you can use DeleteGlobalReplicationGroup API to delete the Global Datastore while retainining the primary cluster using Retain…= true.</p> </li> </ul> <p>Since the Global Datastore has only a primary cluster, you can delete the Global Datastore while retaining the primary by setting <code>RetainPrimaryCluster=true</code>.</p> <p>When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"DeleteReplicationGroup":{
|
||||
"name":"DeleteReplicationGroup",
|
||||
"http":{
|
||||
|
|
@ -532,6 +591,24 @@
|
|||
],
|
||||
"documentation":"<p>Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.</p> <p>By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.</p>"
|
||||
},
|
||||
"DescribeGlobalReplicationGroups":{
|
||||
"name":"DescribeGlobalReplicationGroups",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeGlobalReplicationGroupsMessage"},
|
||||
"output":{
|
||||
"shape":"DescribeGlobalReplicationGroupsResult",
|
||||
"resultWrapper":"DescribeGlobalReplicationGroupsResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"GlobalReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Returns information about a particular global replication group. If no identifier is specified, returns information about all Global Datastores. </p>"
|
||||
},
|
||||
"DescribeReplicationGroups":{
|
||||
"name":"DescribeReplicationGroups",
|
||||
"http":{
|
||||
|
|
@ -640,6 +717,62 @@
|
|||
],
|
||||
"documentation":"<p>Returns details of the update actions </p>"
|
||||
},
|
||||
"DisassociateGlobalReplicationGroup":{
|
||||
"name":"DisassociateGlobalReplicationGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DisassociateGlobalReplicationGroupMessage"},
|
||||
"output":{
|
||||
"shape":"DisassociateGlobalReplicationGroupResult",
|
||||
"resultWrapper":"DisassociateGlobalReplicationGroupResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"GlobalReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidGlobalReplicationGroupStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Remove a secondary cluster from the Global Datastore using the Global Datastore name. The secondary cluster will no longer receive updates from the primary cluster, but will remain as a standalone cluster in that AWS region.</p>"
|
||||
},
|
||||
"FailoverGlobalReplicationGroup":{
|
||||
"name":"FailoverGlobalReplicationGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"FailoverGlobalReplicationGroupMessage"},
|
||||
"output":{
|
||||
"shape":"FailoverGlobalReplicationGroupResult",
|
||||
"resultWrapper":"FailoverGlobalReplicationGroupResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"GlobalReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidGlobalReplicationGroupStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Used to failover the primary region to a selected secondary region.</p>"
|
||||
},
|
||||
"IncreaseNodeGroupsInGlobalReplicationGroup":{
|
||||
"name":"IncreaseNodeGroupsInGlobalReplicationGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"IncreaseNodeGroupsInGlobalReplicationGroupMessage"},
|
||||
"output":{
|
||||
"shape":"IncreaseNodeGroupsInGlobalReplicationGroupResult",
|
||||
"resultWrapper":"IncreaseNodeGroupsInGlobalReplicationGroupResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"GlobalReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidGlobalReplicationGroupStateFault"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>Increase the number of node groups in the Global Datastore</p>"
|
||||
},
|
||||
"IncreaseReplicaCount":{
|
||||
"name":"IncreaseReplicaCount",
|
||||
"http":{
|
||||
|
|
@ -745,7 +878,8 @@
|
|||
{"shape":"CacheParameterGroupNotFoundFault"},
|
||||
{"shape":"InvalidCacheParameterGroupStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"InvalidGlobalReplicationGroupStateFault"}
|
||||
],
|
||||
"documentation":"<p>Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.</p>"
|
||||
},
|
||||
|
|
@ -768,6 +902,24 @@
|
|||
],
|
||||
"documentation":"<p>Modifies an existing cache subnet group.</p>"
|
||||
},
|
||||
"ModifyGlobalReplicationGroup":{
|
||||
"name":"ModifyGlobalReplicationGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ModifyGlobalReplicationGroupMessage"},
|
||||
"output":{
|
||||
"shape":"ModifyGlobalReplicationGroupResult",
|
||||
"resultWrapper":"ModifyGlobalReplicationGroupResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"GlobalReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidGlobalReplicationGroupStateFault"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>Modifies the settings for a Global Datastore.</p>"
|
||||
},
|
||||
"ModifyReplicationGroup":{
|
||||
"name":"ModifyReplicationGroup",
|
||||
"http":{
|
||||
|
|
@ -842,6 +994,24 @@
|
|||
],
|
||||
"documentation":"<p>Allows you to purchase a reserved cache node offering.</p>"
|
||||
},
|
||||
"RebalanceSlotsInGlobalReplicationGroup":{
|
||||
"name":"RebalanceSlotsInGlobalReplicationGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RebalanceSlotsInGlobalReplicationGroupMessage"},
|
||||
"output":{
|
||||
"shape":"RebalanceSlotsInGlobalReplicationGroupResult",
|
||||
"resultWrapper":"RebalanceSlotsInGlobalReplicationGroupResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"GlobalReplicationGroupNotFoundFault"},
|
||||
{"shape":"InvalidGlobalReplicationGroupStateFault"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>Redistribute slots to ensure unifirom distribution across existing shards in the cluster.</p>"
|
||||
},
|
||||
"RebootCacheCluster":{
|
||||
"name":"RebootCacheCluster",
|
||||
"http":{
|
||||
|
|
@ -893,7 +1063,8 @@
|
|||
{"shape":"InvalidCacheParameterGroupStateFault"},
|
||||
{"shape":"CacheParameterGroupNotFoundFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"InvalidGlobalReplicationGroupStateFault"}
|
||||
],
|
||||
"documentation":"<p>Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the <code>ResetAllParameters</code> and <code>CacheParameterGroupName</code> parameters.</p>"
|
||||
},
|
||||
|
|
@ -1014,7 +1185,7 @@
|
|||
},
|
||||
"ScaleDownModifications":{
|
||||
"shape":"NodeTypeList",
|
||||
"documentation":"<p>A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.</p> <p>When scaling down on a Redis cluster or replication group using <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code>, use a value from this list for the <code>CacheNodeType</code> parameter.</p>"
|
||||
"documentation":"<p>A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the allowed node types you can use to modify your cluster or replication group.</p>"
|
||||
|
|
@ -1169,7 +1340,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the compute and memory capacity node type for the cluster.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the compute and memory capacity node type for the cluster.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
},
|
||||
"Engine":{
|
||||
"shape":"String",
|
||||
|
|
@ -1366,7 +1537,7 @@
|
|||
},
|
||||
"CacheNodeStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The current state of this cache node.</p>"
|
||||
"documentation":"<p>The current state of this cache node, one of the following values: <code>available</code>, <code>creating</code>, <code>rebooting</code>, or <code>deleting</code>.</p>"
|
||||
},
|
||||
"CacheNodeCreateTime":{
|
||||
"shape":"TStamp",
|
||||
|
|
@ -1389,7 +1560,7 @@
|
|||
"documentation":"<p>The Availability Zone where this node was created and now resides.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
"documentation":"<p>Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
},
|
||||
"CacheNodeIdsList":{
|
||||
"type":"list",
|
||||
|
|
@ -1534,6 +1705,10 @@
|
|||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The description for this cache parameter group.</p>"
|
||||
},
|
||||
"IsGlobal":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates whether the parameter group is associated with a Global Datastore</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <code>CreateCacheParameterGroup</code> operation.</p>",
|
||||
|
|
@ -1984,7 +2159,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
"documentation":"<p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
},
|
||||
"Engine":{
|
||||
"shape":"String",
|
||||
|
|
@ -2141,6 +2316,33 @@
|
|||
"CacheSubnetGroup":{"shape":"CacheSubnetGroup"}
|
||||
}
|
||||
},
|
||||
"CreateGlobalReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"GlobalReplicationGroupIdSuffix",
|
||||
"PrimaryReplicationGroupId"
|
||||
],
|
||||
"members":{
|
||||
"GlobalReplicationGroupIdSuffix":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The suffix for name of a Global Datastore. The suffix guarantees uniqueness of the Global Datastore name across multiple regions.</p>"
|
||||
},
|
||||
"GlobalReplicationGroupDescription":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Provides details of the Global Datastore</p>"
|
||||
},
|
||||
"PrimaryReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateGlobalReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroup":{"shape":"GlobalReplicationGroup"}
|
||||
}
|
||||
},
|
||||
"CreateReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2156,6 +2358,10 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>A user-created description for the replication group.</p>"
|
||||
},
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"PrimaryClusterId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of <code>available</code>.</p> <p>This parameter is not required if <code>NumCacheClusters</code>, <code>NumNodeGroups</code>, or <code>ReplicasPerNodeGroup</code> is specified.</p>"
|
||||
|
|
@ -2186,7 +2392,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
"documentation":"<p>The compute and memory capacity of the nodes in the node group (shard).</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
},
|
||||
"Engine":{
|
||||
"shape":"String",
|
||||
|
|
@ -2262,7 +2468,7 @@
|
|||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ID of the KMS key used to encrypt the disk on the cluster.</p>"
|
||||
"documentation":"<p>The ID of the KMS key used to encrypt the disk in the cluster.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <code>CreateReplicationGroup</code> operation.</p>"
|
||||
|
|
@ -2320,6 +2526,42 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"CustomerNodeEndpoint"}
|
||||
},
|
||||
"DecreaseNodeGroupsInGlobalReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"GlobalReplicationGroupId",
|
||||
"NodeGroupCount",
|
||||
"ApplyImmediately"
|
||||
],
|
||||
"members":{
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"NodeGroupCount":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The number of node groups (shards) that results from the modification of the shard configuration</p>"
|
||||
},
|
||||
"GlobalNodeGroupsToRemove":{
|
||||
"shape":"GlobalNodeGroupIdList",
|
||||
"documentation":"<p>If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster. </p>"
|
||||
},
|
||||
"GlobalNodeGroupsToRetain":{
|
||||
"shape":"GlobalNodeGroupIdList",
|
||||
"documentation":"<p>If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster. </p>"
|
||||
},
|
||||
"ApplyImmediately":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DecreaseNodeGroupsInGlobalReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroup":{"shape":"GlobalReplicationGroup"}
|
||||
}
|
||||
},
|
||||
"DecreaseReplicaCountMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2409,6 +2651,29 @@
|
|||
},
|
||||
"documentation":"<p>Represents the input of a <code>DeleteCacheSubnetGroup</code> operation.</p>"
|
||||
},
|
||||
"DeleteGlobalReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"GlobalReplicationGroupId",
|
||||
"RetainPrimaryReplicationGroup"
|
||||
],
|
||||
"members":{
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"RetainPrimaryReplicationGroup":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>If set to <code>true</code>, the primary replication is retained as a standalone replication group. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteGlobalReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroup":{"shape":"GlobalReplicationGroup"}
|
||||
}
|
||||
},
|
||||
"DeleteReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":["ReplicationGroupId"],
|
||||
|
|
@ -2643,6 +2908,40 @@
|
|||
},
|
||||
"documentation":"<p>Represents the input of a <code>DescribeEvents</code> operation.</p>"
|
||||
},
|
||||
"DescribeGlobalReplicationGroupsMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. </p>"
|
||||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
|
||||
},
|
||||
"ShowMemberInfo":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Returns the list of members that comprise the Global Datastore.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeGlobalReplicationGroupsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. ></p>"
|
||||
},
|
||||
"GlobalReplicationGroups":{
|
||||
"shape":"GlobalReplicationGroupList",
|
||||
"documentation":"<p>Indicates the slot configuration and global identifier for each slice group.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeReplicationGroupsMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2674,7 +2973,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
"documentation":"<p>The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
},
|
||||
"Duration":{
|
||||
"shape":"String",
|
||||
|
|
@ -2708,7 +3007,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
"documentation":"<p>The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
},
|
||||
"Duration":{
|
||||
"shape":"String",
|
||||
|
|
@ -2847,6 +3146,34 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DisassociateGlobalReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"GlobalReplicationGroupId",
|
||||
"ReplicationGroupId",
|
||||
"ReplicationGroupRegion"
|
||||
],
|
||||
"members":{
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"ReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the secondary cluster you wish to remove from the Global Datastore</p>"
|
||||
},
|
||||
"ReplicationGroupRegion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS region of secondary cluster you wish to remove from the Global Datastore</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DisassociateGlobalReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroup":{"shape":"GlobalReplicationGroup"}
|
||||
}
|
||||
},
|
||||
"Double":{"type":"double"},
|
||||
"EC2SecurityGroup":{
|
||||
"type":"structure",
|
||||
|
|
@ -2953,6 +3280,228 @@
|
|||
},
|
||||
"documentation":"<p>Represents the output of a <code>DescribeEvents</code> operation.</p>"
|
||||
},
|
||||
"FailoverGlobalReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"GlobalReplicationGroupId",
|
||||
"PrimaryRegion",
|
||||
"PrimaryReplicationGroupId"
|
||||
],
|
||||
"members":{
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"PrimaryRegion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS region of the primary cluster of the Global Datastore</p>"
|
||||
},
|
||||
"PrimaryReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the primary replication group</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"FailoverGlobalReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroup":{"shape":"GlobalReplicationGroup"}
|
||||
}
|
||||
},
|
||||
"GlobalNodeGroup":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalNodeGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the global node group</p>"
|
||||
},
|
||||
"Slots":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The keyspace for this node group</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Indicates the slot configuration and global identifier for a slice group.</p>"
|
||||
},
|
||||
"GlobalNodeGroupIdList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"String",
|
||||
"locationName":"GlobalNodeGroupId"
|
||||
}
|
||||
},
|
||||
"GlobalNodeGroupList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"GlobalNodeGroup",
|
||||
"locationName":"GlobalNodeGroup"
|
||||
}
|
||||
},
|
||||
"GlobalReplicationGroup":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"GlobalReplicationGroupDescription":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The optional description of the Global Datastore</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of the Global Datastore</p>"
|
||||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node type of the Global Datastore</p>"
|
||||
},
|
||||
"Engine":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Elasticache engine. For preview, it is Redis only.</p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Elasticache Redis engine version. For preview, it is Redis version 5.0.5 only.</p>"
|
||||
},
|
||||
"Members":{
|
||||
"shape":"GlobalReplicationGroupMemberList",
|
||||
"documentation":"<p>The replication groups that comprise the Global Datastore.</p>"
|
||||
},
|
||||
"ClusterEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A flag that indicates whether the Global Datastore is cluster enabled.</p>"
|
||||
},
|
||||
"GlobalNodeGroups":{
|
||||
"shape":"GlobalNodeGroupList",
|
||||
"documentation":"<p>Indicates the slot configuration and global identifier for each slice group.</p>"
|
||||
},
|
||||
"AuthTokenEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A flag that enables using an <code>AuthToken</code> (password) when issuing Redis commands.</p> <p>Default: <code>false</code> </p>"
|
||||
},
|
||||
"TransitEncryptionEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A flag that enables in-transit encryption when set to true. You cannot modify the value of <code>TransitEncryptionEnabled</code> after the cluster is created. To enable in-transit encryption on a cluster you must set <code>TransitEncryptionEnabled</code> to true when you create a cluster. </p>"
|
||||
},
|
||||
"AtRestEncryptionEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A flag that enables encryption at rest when set to <code>true</code>.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the replication group is created. To enable encryption at rest on a replication group you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create the replication group. </p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different AWS region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.</p> <ul> <li> <p>The <b>GlobalReplicationGroupId</b> represents the name of the Global Datastore, which is what you use to associate a secondary cluster.</p> </li> </ul>",
|
||||
"wrapper":true
|
||||
},
|
||||
"GlobalReplicationGroupAlreadyExistsFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The Global Datastore name already exists.</p>",
|
||||
"error":{
|
||||
"code":"GlobalReplicationGroupAlreadyExistsFault",
|
||||
"httpStatusCode":400,
|
||||
"senderFault":true
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"GlobalReplicationGroupInfo":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"GlobalReplicationGroupMemberRole":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The role of the replication group in a Global Datastore. Can be primary or secondary.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The name of the Global Datastore and role of this replication group in the Global Datastore.</p>"
|
||||
},
|
||||
"GlobalReplicationGroupList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"GlobalReplicationGroup",
|
||||
"locationName":"GlobalReplicationGroup"
|
||||
}
|
||||
},
|
||||
"GlobalReplicationGroupMember":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The replication group id of the Global Datastore member.</p>"
|
||||
},
|
||||
"ReplicationGroupRegion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS region of the Global Datastore member.</p>"
|
||||
},
|
||||
"Role":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Indicates the role of the replication group, primary or secondary.</p>"
|
||||
},
|
||||
"AutomaticFailover":{
|
||||
"shape":"AutomaticFailoverStatus",
|
||||
"documentation":"<p>Indicates whether automatic failover is enabled for the replication group.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of the membership of the replication group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A member of a Global Datastore. It contains the Replication Group Id, the AWS region and the role of the replication group. </p>",
|
||||
"wrapper":true
|
||||
},
|
||||
"GlobalReplicationGroupMemberList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"GlobalReplicationGroupMember",
|
||||
"locationName":"GlobalReplicationGroupMember"
|
||||
}
|
||||
},
|
||||
"GlobalReplicationGroupNotFoundFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The Global Datastore does not exist</p>",
|
||||
"error":{
|
||||
"code":"GlobalReplicationGroupNotFoundFault",
|
||||
"httpStatusCode":404,
|
||||
"senderFault":true
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"IncreaseNodeGroupsInGlobalReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"GlobalReplicationGroupId",
|
||||
"NodeGroupCount",
|
||||
"ApplyImmediately"
|
||||
],
|
||||
"members":{
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"NodeGroupCount":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The number of node groups you wish to add</p>"
|
||||
},
|
||||
"RegionalConfigurations":{
|
||||
"shape":"RegionalConfigurationList",
|
||||
"documentation":"<p>Describes the replication group IDs, the AWS regions where they are stored and the shard configuration for each that comprise the Global Datastore</p>"
|
||||
},
|
||||
"ApplyImmediately":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"IncreaseNodeGroupsInGlobalReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroup":{"shape":"GlobalReplicationGroup"}
|
||||
}
|
||||
},
|
||||
"IncreaseReplicaCountMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -3046,6 +3595,18 @@
|
|||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidGlobalReplicationGroupStateFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The Global Datastore is not available</p>",
|
||||
"error":{
|
||||
"code":"InvalidGlobalReplicationGroupState",
|
||||
"httpStatusCode":400,
|
||||
"senderFault":true
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidKMSKeyFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3301,6 +3862,45 @@
|
|||
"CacheSubnetGroup":{"shape":"CacheSubnetGroup"}
|
||||
}
|
||||
},
|
||||
"ModifyGlobalReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"GlobalReplicationGroupId",
|
||||
"ApplyImmediately"
|
||||
],
|
||||
"members":{
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"ApplyImmediately":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group. If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first. </p>"
|
||||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A valid cache node type that you want to scale this Global Datastore to.</p>"
|
||||
},
|
||||
"EngineVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The upgraded version of the cache engine to be run on the clusters in the Global Datastore. </p>"
|
||||
},
|
||||
"GlobalReplicationGroupDescription":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description of the Global Datastore</p>"
|
||||
},
|
||||
"AutomaticFailoverEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ModifyGlobalReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroup":{"shape":"GlobalReplicationGroup"}
|
||||
}
|
||||
},
|
||||
"ModifyReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":["ReplicationGroupId"],
|
||||
|
|
@ -3925,6 +4525,29 @@
|
|||
"ReservedCacheNode":{"shape":"ReservedCacheNode"}
|
||||
}
|
||||
},
|
||||
"RebalanceSlotsInGlobalReplicationGroupMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"GlobalReplicationGroupId",
|
||||
"ApplyImmediately"
|
||||
],
|
||||
"members":{
|
||||
"GlobalReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the Global Datastore</p>"
|
||||
},
|
||||
"ApplyImmediately":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>If <code>True</code>, redistribution is applied immediately.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RebalanceSlotsInGlobalReplicationGroupResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GlobalReplicationGroup":{"shape":"GlobalReplicationGroup"}
|
||||
}
|
||||
},
|
||||
"RebootCacheClusterMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -3971,6 +4594,36 @@
|
|||
"locationName":"RecurringCharge"
|
||||
}
|
||||
},
|
||||
"RegionalConfiguration":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ReplicationGroupId",
|
||||
"ReplicationGroupRegion",
|
||||
"ReshardingConfiguration"
|
||||
],
|
||||
"members":{
|
||||
"ReplicationGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the secondary cluster</p>"
|
||||
},
|
||||
"ReplicationGroupRegion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS region where the cluster is stored</p>"
|
||||
},
|
||||
"ReshardingConfiguration":{
|
||||
"shape":"ReshardingConfigurationList",
|
||||
"documentation":"<p>A list of <code>PreferredAvailabilityZones</code> objects that specifies the configuration of a node group in the resharded cluster. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A list of the replication groups </p>"
|
||||
},
|
||||
"RegionalConfigurationList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"RegionalConfiguration",
|
||||
"locationName":"RegionalConfiguration"
|
||||
}
|
||||
},
|
||||
"RemoveReplicasList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
|
|
@ -4011,6 +4664,10 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>The user supplied description of the replication group.</p>"
|
||||
},
|
||||
"GlobalReplicationGroupInfo":{
|
||||
"shape":"GlobalReplicationGroupInfo",
|
||||
"documentation":"<p>The name of the Global Datastore and role of this replication group in the Global Datastore.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The current state of this replication group - <code>creating</code>, <code>available</code>, <code>modifying</code>, <code>deleting</code>, <code>create-failed</code>, <code>snapshotting</code>.</p>"
|
||||
|
|
@ -4188,7 +4845,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node type for the reserved cache nodes.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
"documentation":"<p>The cache node type for the reserved cache nodes.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TStamp",
|
||||
|
|
@ -4300,7 +4957,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cache node type for the reserved cache node.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
"documentation":"<p>The cache node type for the reserved cache node.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
},
|
||||
"Duration":{
|
||||
"shape":"Integer",
|
||||
|
|
@ -4638,7 +5295,7 @@
|
|||
},
|
||||
"CacheNodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the compute and memory capacity node type for the source cluster.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the compute and memory capacity node type for the source cluster.</p> <p>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.</p> <ul> <li> <p>General purpose:</p> <ul> <li> <p>Current generation: </p> <p> <b>M5 node types:</b> <code>cache.m5.large</code>, <code>cache.m5.xlarge</code>, <code>cache.m5.2xlarge</code>, <code>cache.m5.4xlarge</code>, <code>cache.m5.12xlarge</code>, <code>cache.m5.24xlarge</code> </p> <p> <b>M4 node types:</b> <code>cache.m4.large</code>, <code>cache.m4.xlarge</code>, <code>cache.m4.2xlarge</code>, <code>cache.m4.4xlarge</code>, <code>cache.m4.10xlarge</code> </p> <p> <b>T3 node types:</b> <code>cache.t3.micro</code>, <code>cache.t3.small</code>, <code>cache.t3.medium</code> </p> <p> <b>T2 node types:</b> <code>cache.t2.micro</code>, <code>cache.t2.small</code>, <code>cache.t2.medium</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>T1 node types:</b> <code>cache.t1.micro</code> </p> <p> <b>M1 node types:</b> <code>cache.m1.small</code>, <code>cache.m1.medium</code>, <code>cache.m1.large</code>, <code>cache.m1.xlarge</code> </p> <p> <b>M3 node types:</b> <code>cache.m3.medium</code>, <code>cache.m3.large</code>, <code>cache.m3.xlarge</code>, <code>cache.m3.2xlarge</code> </p> </li> </ul> </li> <li> <p>Compute optimized:</p> <ul> <li> <p>Previous generation: (not recommended)</p> <p> <b>C1 node types:</b> <code>cache.c1.xlarge</code> </p> </li> </ul> </li> <li> <p>Memory optimized:</p> <ul> <li> <p>Current generation: </p> <p> <b>R5 node types:</b> <code>cache.r5.large</code>, <code>cache.r5.xlarge</code>, <code>cache.r5.2xlarge</code>, <code>cache.r5.4xlarge</code>, <code>cache.r5.12xlarge</code>, <code>cache.r5.24xlarge</code> </p> <p> <b>R4 node types:</b> <code>cache.r4.large</code>, <code>cache.r4.xlarge</code>, <code>cache.r4.2xlarge</code>, <code>cache.r4.4xlarge</code>, <code>cache.r4.8xlarge</code>, <code>cache.r4.16xlarge</code> </p> </li> <li> <p>Previous generation: (not recommended)</p> <p> <b>M2 node types:</b> <code>cache.m2.xlarge</code>, <code>cache.m2.2xlarge</code>, <code>cache.m2.4xlarge</code> </p> <p> <b>R3 node types:</b> <code>cache.r3.large</code>, <code>cache.r3.xlarge</code>, <code>cache.r3.2xlarge</code>, <code>cache.r3.4xlarge</code>, <code>cache.r3.8xlarge</code> </p> </li> </ul> </li> </ul> <p> <b>Additional node type info</b> </p> <ul> <li> <p>All current generation instance types are created in Amazon VPC by default.</p> </li> <li> <p>Redis append-only files (AOF) are not supported for T1 or T2 instances.</p> </li> <li> <p>Redis Multi-AZ with automatic failover is not supported on T1 instances.</p> </li> <li> <p>Redis configuration variables <code>appendonly</code> and <code>appendfsync</code> are not supported on Redis version 2.8.22 and later.</p> </li> </ul>"
|
||||
},
|
||||
"Engine":{
|
||||
"shape":"String",
|
||||
|
|
|
|||
|
|
@ -760,7 +760,7 @@
|
|||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The tags. Each resource can have a maximum of 10 tags.</p>"
|
||||
"documentation":"<p>The tags.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1045,7 +1045,7 @@
|
|||
},
|
||||
"SslPolicy":{
|
||||
"shape":"SslPolicyName",
|
||||
"documentation":"<p>[HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.</p>"
|
||||
"documentation":"<p>[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. The following are the possible values:</p> <ul> <li> <p> <code>ELBSecurityPolicy-2016-08</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-TLS-1-0-2015-04</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-TLS-1-1-2017-01</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-TLS-1-2-2017-01</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-TLS-1-2-Ext-2018-06</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-FS-2018-06</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-FS-1-1-2019-08</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-FS-1-2-2019-08</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-FS-1-2-Res-2019-08</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Application Load Balancers Guide</i> and <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Network Load Balancers Guide</i>.</p>"
|
||||
},
|
||||
"Certificates":{
|
||||
"shape":"CertificateList",
|
||||
|
|
@ -1505,7 +1505,7 @@
|
|||
"members":{
|
||||
"SslPolicies":{
|
||||
"shape":"SslPolicies",
|
||||
"documentation":"<p>Information about the policies.</p>"
|
||||
"documentation":"<p>Information about the security policies.</p>"
|
||||
},
|
||||
"NextMarker":{
|
||||
"shape":"Marker",
|
||||
|
|
@ -1519,7 +1519,7 @@
|
|||
"members":{
|
||||
"ResourceArns":{
|
||||
"shape":"ResourceArns",
|
||||
"documentation":"<p>The Amazon Resource Names (ARN) of the resources.</p>"
|
||||
"documentation":"<p>The Amazon Resource Names (ARN) of the resources. You can specify up to 20 resources in a single call.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1912,7 +1912,7 @@
|
|||
},
|
||||
"SslPolicy":{
|
||||
"shape":"SslPolicyName",
|
||||
"documentation":"<p>[HTTPS or TLS listener] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.</p>"
|
||||
"documentation":"<p>[HTTPS or TLS listener] The security policy that defines which protocols and ciphers are supported.</p>"
|
||||
},
|
||||
"DefaultActions":{
|
||||
"shape":"Actions",
|
||||
|
|
@ -2028,7 +2028,7 @@
|
|||
"members":{
|
||||
"Key":{
|
||||
"shape":"LoadBalancerAttributeKey",
|
||||
"documentation":"<p>The name of the attribute.</p> <p>The following attributes are supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - Indicates whether access logs are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - The prefix for the location in the S3 bucket for the access logs.</p> </li> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul> <p>The following attributes are supported by only Application Load Balancers:</p> <ul> <li> <p> <code>idle_timeout.timeout_seconds</code> - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.</p> </li> <li> <p> <code>routing.http.drop_invalid_header_fields.enabled</code> - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (<code>true</code>) or routed to targets (<code>false</code>). The default is <code>false</code>.</p> </li> <li> <p> <code>routing.http2.enabled</code> - Indicates whether HTTP/2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>true</code>.</p> </li> </ul> <p>The following attributes are supported by only Network Load Balancers:</p> <ul> <li> <p> <code>load_balancing.cross_zone.enabled</code> - Indicates whether cross-zone load balancing is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the attribute.</p> <p>The following attributes are supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - Indicates whether access logs are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - The prefix for the location in the S3 bucket for the access logs.</p> </li> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul> <p>The following attributes are supported by only Application Load Balancers:</p> <ul> <li> <p> <code>idle_timeout.timeout_seconds</code> - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.</p> </li> <li> <p> <code>routing.http.drop_invalid_header_fields.enabled</code> - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (<code>true</code>) or routed to targets (<code>false</code>). The default is <code>false</code>.</p> </li> <li> <p> <code>routing.http2.enabled</code> - Indicates whether HTTP/2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>true</code>. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens.</p> </li> </ul> <p>The following attributes are supported by only Network Load Balancers:</p> <ul> <li> <p> <code>load_balancing.cross_zone.enabled</code> - Indicates whether cross-zone load balancing is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"LoadBalancerAttributeValue",
|
||||
|
|
@ -2140,7 +2140,7 @@
|
|||
},
|
||||
"SslPolicy":{
|
||||
"shape":"SslPolicyName",
|
||||
"documentation":"<p>[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Application Load Balancers Guide</i>.</p>"
|
||||
"documentation":"<p>[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. The following are the possible values:</p> <ul> <li> <p> <code>ELBSecurityPolicy-2016-08</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-TLS-1-0-2015-04</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-TLS-1-1-2017-01</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-TLS-1-2-2017-01</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-TLS-1-2-Ext-2018-06</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-FS-2018-06</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-FS-1-1-2019-08</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-FS-1-2-2019-08</code> </p> </li> <li> <p> <code>ELBSecurityPolicy-FS-1-2-Res-2019-08</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Application Load Balancers Guide</i> and <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Network Load Balancers Guide</i>.</p>"
|
||||
},
|
||||
"Certificates":{
|
||||
"shape":"CertificateList",
|
||||
|
|
@ -3006,7 +3006,7 @@
|
|||
"members":{
|
||||
"Key":{
|
||||
"shape":"TargetGroupAttributeKey",
|
||||
"documentation":"<p>The name of the attribute.</p> <p>The following attribute is supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>deregistration_delay.timeout_seconds</code> - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from <code>draining</code> to <code>unused</code>. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.</p> </li> </ul> <p>The following attributes are supported by Application Load Balancers if the target is not a Lambda function:</p> <ul> <li> <p> <code>load_balancing.algorithm.type</code> - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is <code>round_robin</code> or <code>least_outstanding_requests</code>. The default is <code>round_robin</code>.</p> </li> <li> <p> <code>slow_start.duration_seconds</code> - The time period, in seconds, during which a newly registered target receives a linearly increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). Slow start mode is disabled by default.</p> </li> <li> <p> <code>stickiness.enabled</code> - Indicates whether sticky sessions are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>stickiness.type</code> - The type of sticky sessions. The possible value is <code>lb_cookie</code>.</p> </li> <li> <p> <code>stickiness.lb_cookie.duration_seconds</code> - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p> </li> </ul> <p>The following attribute is supported only if the target is a Lambda function.</p> <ul> <li> <p> <code>lambda.multi_value_headers.enabled</code> - Indicates whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>. If the value is <code>false</code> and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.</p> </li> </ul> <p>The following attribute is supported only by Network Load Balancers:</p> <ul> <li> <p> <code>proxy_protocol_v2.enabled</code> - Indicates whether Proxy Protocol version 2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the attribute.</p> <p>The following attributes are supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>deregistration_delay.timeout_seconds</code> - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from <code>draining</code> to <code>unused</code>. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.</p> </li> <li> <p> <code>stickiness.enabled</code> - Indicates whether sticky sessions are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>stickiness.type</code> - The type of sticky sessions. The possible values are <code>lb_cookie</code> for Application Load Balancers or <code>source_ip</code> for Network Load Balancers.</p> </li> </ul> <p>The following attributes are supported by Application Load Balancers if the target is not a Lambda function:</p> <ul> <li> <p> <code>load_balancing.algorithm.type</code> - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is <code>round_robin</code> or <code>least_outstanding_requests</code>. The default is <code>round_robin</code>.</p> </li> <li> <p> <code>slow_start.duration_seconds</code> - The time period, in seconds, during which a newly registered target receives a linearly increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). Slow start mode is disabled by default.</p> </li> <li> <p> <code>stickiness.lb_cookie.duration_seconds</code> - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p> </li> </ul> <p>The following attribute is supported only if the target is a Lambda function.</p> <ul> <li> <p> <code>lambda.multi_value_headers.enabled</code> - Indicates whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>. If the value is <code>false</code> and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.</p> </li> </ul> <p>The following attribute is supported only by Network Load Balancers:</p> <ul> <li> <p> <code>proxy_protocol_v2.enabled</code> - Indicates whether Proxy Protocol version 2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"TargetGroupAttributeValue",
|
||||
|
|
|
|||
|
|
@ -429,6 +429,7 @@
|
|||
},
|
||||
"appmesh" : {
|
||||
"endpoints" : {
|
||||
"ap-east-1" : { },
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
|
|
@ -929,6 +930,7 @@
|
|||
"ap-southeast-2" : { },
|
||||
"ca-central-1" : { },
|
||||
"eu-central-1" : { },
|
||||
"eu-north-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"us-east-1" : { },
|
||||
|
|
@ -937,6 +939,25 @@
|
|||
"us-west-2" : { }
|
||||
}
|
||||
},
|
||||
"codestar-connections" : {
|
||||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"ca-central-1" : { },
|
||||
"eu-central-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
"us-west-1" : { },
|
||||
"us-west-2" : { }
|
||||
}
|
||||
},
|
||||
"cognito-identity" : {
|
||||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
|
|
@ -948,6 +969,24 @@
|
|||
"eu-central-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"fips-us-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-1"
|
||||
},
|
||||
"hostname" : "cognito-identity-fips.us-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-east-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-2"
|
||||
},
|
||||
"hostname" : "cognito-identity-fips.us-east-2.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-2"
|
||||
},
|
||||
"hostname" : "cognito-identity-fips.us-west-2.amazonaws.com"
|
||||
},
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
"us-west-2" : { }
|
||||
|
|
@ -964,6 +1003,24 @@
|
|||
"eu-central-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"fips-us-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-1"
|
||||
},
|
||||
"hostname" : "cognito-idp-fips.us-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-east-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-2"
|
||||
},
|
||||
"hostname" : "cognito-idp-fips.us-east-2.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-2"
|
||||
},
|
||||
"hostname" : "cognito-idp-fips.us-west-2.amazonaws.com"
|
||||
},
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
"us-west-2" : { }
|
||||
|
|
@ -989,6 +1046,9 @@
|
|||
"protocols" : [ "https" ]
|
||||
},
|
||||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"ca-central-1" : { },
|
||||
|
|
@ -1127,6 +1187,12 @@
|
|||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"fips-ca-central-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "ca-central-1"
|
||||
},
|
||||
"hostname" : "datasync-fips.ca-central-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-1"
|
||||
|
|
@ -1218,6 +1284,12 @@
|
|||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"ca-central-1" : { },
|
||||
"dms-fips" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-1"
|
||||
},
|
||||
"hostname" : "dms-fips.us-west-1.amazonaws.com"
|
||||
},
|
||||
"eu-central-1" : { },
|
||||
"eu-north-1" : { },
|
||||
"eu-west-1" : { },
|
||||
|
|
@ -1327,6 +1399,7 @@
|
|||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"me-south-1" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
|
|
@ -1690,6 +1763,96 @@
|
|||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"fips-ap-northeast-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "ap-northeast-1"
|
||||
},
|
||||
"hostname" : "fms-fips.ap-northeast-1.amazonaws.com"
|
||||
},
|
||||
"fips-ap-northeast-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "ap-northeast-2"
|
||||
},
|
||||
"hostname" : "fms-fips.ap-northeast-2.amazonaws.com"
|
||||
},
|
||||
"fips-ap-south-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "ap-south-1"
|
||||
},
|
||||
"hostname" : "fms-fips.ap-south-1.amazonaws.com"
|
||||
},
|
||||
"fips-ap-southeast-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "ap-southeast-1"
|
||||
},
|
||||
"hostname" : "fms-fips.ap-southeast-1.amazonaws.com"
|
||||
},
|
||||
"fips-ap-southeast-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "ap-southeast-2"
|
||||
},
|
||||
"hostname" : "fms-fips.ap-southeast-2.amazonaws.com"
|
||||
},
|
||||
"fips-ca-central-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "ca-central-1"
|
||||
},
|
||||
"hostname" : "fms-fips.ca-central-1.amazonaws.com"
|
||||
},
|
||||
"fips-eu-central-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "eu-central-1"
|
||||
},
|
||||
"hostname" : "fms-fips.eu-central-1.amazonaws.com"
|
||||
},
|
||||
"fips-eu-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "eu-west-1"
|
||||
},
|
||||
"hostname" : "fms-fips.eu-west-1.amazonaws.com"
|
||||
},
|
||||
"fips-eu-west-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "eu-west-2"
|
||||
},
|
||||
"hostname" : "fms-fips.eu-west-2.amazonaws.com"
|
||||
},
|
||||
"fips-eu-west-3" : {
|
||||
"credentialScope" : {
|
||||
"region" : "eu-west-3"
|
||||
},
|
||||
"hostname" : "fms-fips.eu-west-3.amazonaws.com"
|
||||
},
|
||||
"fips-sa-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "sa-east-1"
|
||||
},
|
||||
"hostname" : "fms-fips.sa-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-1"
|
||||
},
|
||||
"hostname" : "fms-fips.us-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-east-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-2"
|
||||
},
|
||||
"hostname" : "fms-fips.us-east-2.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-1"
|
||||
},
|
||||
"hostname" : "fms-fips.us-west-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-2"
|
||||
},
|
||||
"hostname" : "fms-fips.us-west-2.amazonaws.com"
|
||||
},
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
|
|
@ -1701,7 +1864,10 @@
|
|||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"eu-central-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
|
|
@ -1711,7 +1877,11 @@
|
|||
"forecastquery" : {
|
||||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"eu-central-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
|
|
@ -1768,6 +1938,36 @@
|
|||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"fips-ca-central-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "ca-central-1"
|
||||
},
|
||||
"hostname" : "glacier-fips.ca-central-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-1"
|
||||
},
|
||||
"hostname" : "glacier-fips.us-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-east-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-2"
|
||||
},
|
||||
"hostname" : "glacier-fips.us-east-2.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-1"
|
||||
},
|
||||
"hostname" : "glacier-fips.us-west-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-2"
|
||||
},
|
||||
"hostname" : "glacier-fips.us-west-2.amazonaws.com"
|
||||
},
|
||||
"me-south-1" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
|
|
@ -2286,6 +2486,14 @@
|
|||
"us-east-1" : { }
|
||||
}
|
||||
},
|
||||
"managedblockchain" : {
|
||||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"us-east-1" : { }
|
||||
}
|
||||
},
|
||||
"marketplacecommerceanalytics" : {
|
||||
"endpoints" : {
|
||||
"us-east-1" : { }
|
||||
|
|
@ -2570,6 +2778,12 @@
|
|||
},
|
||||
"hostname" : "rds.eu-west-2.amazonaws.com"
|
||||
},
|
||||
"eu-west-3" : {
|
||||
"credentialScope" : {
|
||||
"region" : "eu-west-3"
|
||||
},
|
||||
"hostname" : "rds.eu-west-3.amazonaws.com"
|
||||
},
|
||||
"me-south-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "me-south-1"
|
||||
|
|
@ -3483,6 +3697,7 @@
|
|||
},
|
||||
"servicecatalog" : {
|
||||
"endpoints" : {
|
||||
"ap-east-1" : { },
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
|
|
@ -3494,6 +3709,7 @@
|
|||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"me-south-1" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-1-fips" : {
|
||||
|
|
@ -3584,6 +3800,30 @@
|
|||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"fips-us-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-1"
|
||||
},
|
||||
"hostname" : "sms-fips.us-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-east-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-2"
|
||||
},
|
||||
"hostname" : "sms-fips.us-east-2.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-1"
|
||||
},
|
||||
"hostname" : "sms-fips.us-west-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-2"
|
||||
},
|
||||
"hostname" : "sms-fips.us-west-2.amazonaws.com"
|
||||
},
|
||||
"me-south-1" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
|
|
@ -4130,6 +4370,12 @@
|
|||
}
|
||||
},
|
||||
"services" : {
|
||||
"acm" : {
|
||||
"endpoints" : {
|
||||
"cn-north-1" : { },
|
||||
"cn-northwest-1" : { }
|
||||
}
|
||||
},
|
||||
"api.ecr" : {
|
||||
"endpoints" : {
|
||||
"cn-north-1" : {
|
||||
|
|
@ -4180,6 +4426,12 @@
|
|||
"cn-northwest-1" : { }
|
||||
}
|
||||
},
|
||||
"backup" : {
|
||||
"endpoints" : {
|
||||
"cn-north-1" : { },
|
||||
"cn-northwest-1" : { }
|
||||
}
|
||||
},
|
||||
"batch" : {
|
||||
"endpoints" : {
|
||||
"cn-north-1" : { },
|
||||
|
|
@ -4404,6 +4656,12 @@
|
|||
"cn-northwest-1" : { }
|
||||
}
|
||||
},
|
||||
"iotsecuredtunneling" : {
|
||||
"endpoints" : {
|
||||
"cn-north-1" : { },
|
||||
"cn-northwest-1" : { }
|
||||
}
|
||||
},
|
||||
"kinesis" : {
|
||||
"endpoints" : {
|
||||
"cn-north-1" : { },
|
||||
|
|
@ -4746,6 +5004,18 @@
|
|||
},
|
||||
"athena" : {
|
||||
"endpoints" : {
|
||||
"fips-us-gov-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-east-1"
|
||||
},
|
||||
"hostname" : "athena-fips.us-gov-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-gov-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-west-1"
|
||||
},
|
||||
"hostname" : "athena-fips.us-gov-west-1.amazonaws.com"
|
||||
},
|
||||
"us-gov-east-1" : { },
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
|
|
@ -4868,6 +5138,12 @@
|
|||
},
|
||||
"datasync" : {
|
||||
"endpoints" : {
|
||||
"fips-us-gov-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-east-1"
|
||||
},
|
||||
"hostname" : "datasync-fips.us-gov-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-gov-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-west-1"
|
||||
|
|
@ -4886,6 +5162,12 @@
|
|||
},
|
||||
"dms" : {
|
||||
"endpoints" : {
|
||||
"dms-fips" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-west-1"
|
||||
},
|
||||
"hostname" : "dms.us-gov-west-1.amazonaws.com"
|
||||
},
|
||||
"us-gov-east-1" : { },
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
|
|
@ -4992,8 +5274,17 @@
|
|||
},
|
||||
"glacier" : {
|
||||
"endpoints" : {
|
||||
"us-gov-east-1" : { },
|
||||
"us-gov-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-east-1"
|
||||
},
|
||||
"hostname" : "glacier.us-gov-east-1.amazonaws.com"
|
||||
},
|
||||
"us-gov-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-west-1"
|
||||
},
|
||||
"hostname" : "glacier.us-gov-west-1.amazonaws.com",
|
||||
"protocols" : [ "http", "https" ]
|
||||
}
|
||||
}
|
||||
|
|
@ -5055,6 +5346,11 @@
|
|||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
"iotsecuredtunneling" : {
|
||||
"endpoints" : {
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
"kinesis" : {
|
||||
"endpoints" : {
|
||||
"us-gov-east-1" : { },
|
||||
|
|
@ -5311,6 +5607,18 @@
|
|||
},
|
||||
"sms" : {
|
||||
"endpoints" : {
|
||||
"fips-us-gov-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-east-1"
|
||||
},
|
||||
"hostname" : "sms-fips.us-gov-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-gov-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-west-1"
|
||||
},
|
||||
"hostname" : "sms-fips.us-gov-west-1.amazonaws.com"
|
||||
},
|
||||
"us-gov-east-1" : { },
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
|
|
@ -5352,6 +5660,7 @@
|
|||
},
|
||||
"storagegateway" : {
|
||||
"endpoints" : {
|
||||
"us-gov-east-1" : { },
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
|
|
@ -5439,6 +5748,12 @@
|
|||
"endpoints" : {
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
"xray" : {
|
||||
"endpoints" : {
|
||||
"us-gov-east-1" : { },
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
}
|
||||
}
|
||||
}, {
|
||||
|
|
@ -5524,6 +5839,12 @@
|
|||
},
|
||||
"dms" : {
|
||||
"endpoints" : {
|
||||
"dms-fips" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-iso-east-1"
|
||||
},
|
||||
"hostname" : "dms.us-iso-east-1.c2s.ic.gov"
|
||||
},
|
||||
"us-iso-east-1" : { }
|
||||
}
|
||||
},
|
||||
|
|
@ -5784,6 +6105,12 @@
|
|||
},
|
||||
"dms" : {
|
||||
"endpoints" : {
|
||||
"dms-fips" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-isob-east-1"
|
||||
},
|
||||
"hostname" : "dms.us-isob-east-1.sc2s.sgov.gov"
|
||||
},
|
||||
"us-isob-east-1" : { }
|
||||
}
|
||||
},
|
||||
|
|
@ -5863,6 +6190,11 @@
|
|||
"us-isob-east-1" : { }
|
||||
}
|
||||
},
|
||||
"license-manager" : {
|
||||
"endpoints" : {
|
||||
"us-isob-east-1" : { }
|
||||
}
|
||||
},
|
||||
"logs" : {
|
||||
"endpoints" : {
|
||||
"us-isob-east-1" : { }
|
||||
|
|
@ -5914,6 +6246,11 @@
|
|||
"us-isob-east-1" : { }
|
||||
}
|
||||
},
|
||||
"ssm" : {
|
||||
"endpoints" : {
|
||||
"us-isob-east-1" : { }
|
||||
}
|
||||
},
|
||||
"states" : {
|
||||
"endpoints" : {
|
||||
"us-isob-east-1" : { }
|
||||
|
|
|
|||
|
|
@ -466,6 +466,56 @@
|
|||
},
|
||||
"documentation":"<p> Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:</p> <ul> <li>Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuration Advanced Options</a> for more information.</li> <li>Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.</li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\">Configuring Advanced Options</a>.</p>"
|
||||
},
|
||||
"AdvancedSecurityOptions":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>True if advanced security is enabled.</p>"
|
||||
},
|
||||
"InternalUserDatabaseEnabled":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>True if the internal user database is enabled.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.</p>"
|
||||
},
|
||||
"AdvancedSecurityOptionsInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>True if advanced security is enabled.</p>"
|
||||
},
|
||||
"InternalUserDatabaseEnabled":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>True if the internal user database is enabled.</p>"
|
||||
},
|
||||
"MasterUserOptions":{
|
||||
"shape":"MasterUserOptions",
|
||||
"documentation":"<p>Credentials for the master user: username and password, ARN, or both.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).</p>"
|
||||
},
|
||||
"AdvancedSecurityOptionsStatus":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Options",
|
||||
"Status"
|
||||
],
|
||||
"members":{
|
||||
"Options":{
|
||||
"shape":"AdvancedSecurityOptions",
|
||||
"documentation":"<p> Specifies advanced security options for the specified Elasticsearch domain.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"OptionStatus",
|
||||
"documentation":"<p> Status of the advanced security options for the specified Elasticsearch domain.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Specifies the status of advanced security options for the specified Elasticsearch domain.</p>"
|
||||
},
|
||||
"BaseException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -613,6 +663,10 @@
|
|||
"DomainEndpointOptions":{
|
||||
"shape":"DomainEndpointOptions",
|
||||
"documentation":"<p>Options to specify configuration that will be applied to the domain endpoint.</p>"
|
||||
},
|
||||
"AdvancedSecurityOptions":{
|
||||
"shape":"AdvancedSecurityOptionsInput",
|
||||
"documentation":"<p>Specifies advanced security options.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1138,6 +1192,10 @@
|
|||
"DomainEndpointOptions":{
|
||||
"shape":"DomainEndpointOptionsStatus",
|
||||
"documentation":"<p>Specifies the <code>DomainEndpointOptions</code> for the Elasticsearch domain.</p>"
|
||||
},
|
||||
"AdvancedSecurityOptions":{
|
||||
"shape":"AdvancedSecurityOptionsStatus",
|
||||
"documentation":"<p>Specifies <code>AdvancedSecurityOptions</code> for the domain. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration of an Elasticsearch domain.</p>"
|
||||
|
|
@ -1235,6 +1293,10 @@
|
|||
"DomainEndpointOptions":{
|
||||
"shape":"DomainEndpointOptions",
|
||||
"documentation":"<p>The current status of the Elasticsearch domain's endpoint options.</p>"
|
||||
},
|
||||
"AdvancedSecurityOptions":{
|
||||
"shape":"AdvancedSecurityOptions",
|
||||
"documentation":"<p>The current status of the Elasticsearch domain's advanced security options.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The current status of an Elasticsearch domain.</p>"
|
||||
|
|
@ -1634,6 +1696,24 @@
|
|||
"ES_APPLICATION_LOGS"
|
||||
]
|
||||
},
|
||||
"MasterUserOptions":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"MasterUserARN":{
|
||||
"shape":"ARN",
|
||||
"documentation":"<p>ARN for the master user (if IAM is enabled).</p>"
|
||||
},
|
||||
"MasterUserName":{
|
||||
"shape":"Username",
|
||||
"documentation":"<p>The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.</p>"
|
||||
},
|
||||
"MasterUserPassword":{
|
||||
"shape":"Password",
|
||||
"documentation":"<p>The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Credentials for the master user: username and password, ARN, or both.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"documentation":"<p> Set this value to limit the number of results returned. </p>",
|
||||
|
|
@ -1719,6 +1799,11 @@
|
|||
},
|
||||
"documentation":"<p>Provides the current status of the entity.</p>"
|
||||
},
|
||||
"Password":{
|
||||
"type":"string",
|
||||
"min":8,
|
||||
"sensitive":true
|
||||
},
|
||||
"PolicyDocument":{
|
||||
"type":"string",
|
||||
"documentation":"<p>Access policy rules for an Elasticsearch domain service endpoints. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies\" target=\"_blank\">Configuring Access Policies</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>. The maximum size of a policy document is 100 KB.</p>"
|
||||
|
|
@ -2159,6 +2244,10 @@
|
|||
"DomainEndpointOptions":{
|
||||
"shape":"DomainEndpointOptions",
|
||||
"documentation":"<p>Options to specify configuration that will be applied to the domain endpoint.</p>"
|
||||
},
|
||||
"AdvancedSecurityOptions":{
|
||||
"shape":"AdvancedSecurityOptionsInput",
|
||||
"documentation":"<p>Specifies advanced security options.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the <code><a>UpdateElasticsearchDomain</a></code> operation. Specifies the type and number of instances in the domain cluster.</p>"
|
||||
|
|
@ -2285,6 +2374,11 @@
|
|||
"min":1,
|
||||
"pattern":"[\\w-]+_[0-9a-zA-Z]+"
|
||||
},
|
||||
"Username":{
|
||||
"type":"string",
|
||||
"min":1,
|
||||
"sensitive":true
|
||||
},
|
||||
"VPCDerivedInfo":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -85,6 +85,7 @@
|
|||
{"shape":"InvalidImportPath"},
|
||||
{"shape":"InvalidExportPath"},
|
||||
{"shape":"InvalidNetworkSettings"},
|
||||
{"shape":"InvalidPerUnitStorageThroughput"},
|
||||
{"shape":"ServiceLimitExceeded"},
|
||||
{"shape":"InternalServerError"},
|
||||
{"shape":"MissingFileSystemConfiguration"}
|
||||
|
|
@ -651,7 +652,15 @@
|
|||
},
|
||||
"ImportedFileChunkSize":{
|
||||
"shape":"Megabytes",
|
||||
"documentation":"<p>(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.</p> <p>The chunk size default is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.</p>"
|
||||
"documentation":"<p>(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.</p> <p>The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.</p>"
|
||||
},
|
||||
"DeploymentType":{
|
||||
"shape":"LustreDeploymentType",
|
||||
"documentation":"<p>(Optional) Choose <code>SCRATCH_1</code> and <code>SCRATCH_2</code> deployment types when you need temporary storage and shorter-term processing of data. The <code>SCRATCH_2</code> deployment type provides in-transit encryption of data and higher burst throughput capacity than <code>SCRATCH_1</code>.</p> <p>Choose <code>PERSISTENT_1</code> deployment type for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html\"> FSx for Lustre Deployment Options</a>.</p> <p>Encryption of data in-transit is automatically enabled when you access a <code>SCRATCH_2</code> or <code>PERSISTENT_1</code> file system from Amazon EC2 instances that <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html\">support this feature</a>. (Default = <code>SCRATCH_1</code>) </p> <p>Encryption of data in-transit for <code>SCRATCH_2</code> and <code>PERSISTENT_1</code> deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html\">Encrypting Data in Transit</a>.</p>"
|
||||
},
|
||||
"PerUnitStorageThroughput":{
|
||||
"shape":"PerUnitStorageThroughput",
|
||||
"documentation":"<p> (Optional) For the <code>PERSISTENT_1</code> deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision. (Default = 200 MB/s/TiB) </p> <p>Valid values are 50, 100, 200.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The Lustre configuration for the file system being created. This value is required if <code>FileSystemType</code> is set to <code>LUSTRE</code>.</p>"
|
||||
|
|
@ -671,15 +680,15 @@
|
|||
},
|
||||
"FileSystemType":{
|
||||
"shape":"FileSystemType",
|
||||
"documentation":"<p>The type of Amazon FSx file system to create.</p>"
|
||||
"documentation":"<p>The type of Amazon FSx file system to create, either <code>WINDOWS</code> or <code>LUSTRE</code>.</p>"
|
||||
},
|
||||
"StorageCapacity":{
|
||||
"shape":"StorageCapacity",
|
||||
"documentation":"<p>The storage capacity of the file system being created.</p> <p>For Windows file systems, valid values are 32 GiB - 65,536 GiB.</p> <p>For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB.</p>"
|
||||
"documentation":"<p>The storage capacity of the file system being created.</p> <p>For Windows file systems, valid values are 32 GiB - 65,536 GiB.</p> <p>For <code>SCRATCH_1</code> Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB. For <code>SCRATCH_2</code> and <code>PERSISTENT_1</code> file systems, valid values are 1200, 2400, then continuing in increments of 2400 GiB.</p>"
|
||||
},
|
||||
"SubnetIds":{
|
||||
"shape":"SubnetIds",
|
||||
"documentation":"<p>Specifies the IDs of the subnets that the file system will be accessible from. For Windows <code>MULTI_AZ_1</code> file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standy file server. You specify one of these subnets as the preferred subnet using the <code>WindowsConfiguration > PreferredSubnetID</code> property.</p> <p>For Windows <code>SINGLE_AZ_1</code> file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.</p>"
|
||||
"documentation":"<p>Specifies the IDs of the subnets that the file system will be accessible from. For Windows <code>MULTI_AZ_1</code> file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the <code>WindowsConfiguration > PreferredSubnetID</code> property.</p> <p>For Windows <code>SINGLE_AZ_1</code> file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.</p>"
|
||||
},
|
||||
"SecurityGroupIds":{
|
||||
"shape":"SecurityGroupIds",
|
||||
|
|
@ -743,7 +752,7 @@
|
|||
},
|
||||
"CopyTagsToBackups":{
|
||||
"shape":"Flag",
|
||||
"documentation":"<p>A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups.</p>"
|
||||
"documentation":"<p>A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration object for the Microsoft Windows file system used in <code>CreateFileSystem</code> and <code>CreateFileSystemFromBackup</code> operations.</p>"
|
||||
|
|
@ -1217,7 +1226,7 @@
|
|||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"KmsKeyId",
|
||||
"documentation":"<p>The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system. Amazon FSx for Lustre does not support KMS encryption. </p>"
|
||||
"documentation":"<p>The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html\">Encrypt</a> in the <i>AWS Key Management Service API Reference</i>.</p>"
|
||||
},
|
||||
"ResourceARN":{
|
||||
"shape":"ResourceARN",
|
||||
|
|
@ -1402,6 +1411,14 @@
|
|||
"documentation":"<p>One or more network settings specified in the request are invalid. <code>InvalidVpcId</code> means that the ID passed for the virtual private cloud (VPC) is invalid. <code>InvalidSubnetIds</code> returns the list of IDs for subnets that are either invalid or not part of the VPC specified. <code>InvalidSecurityGroupIds</code> returns the list of IDs for security groups that are either invalid or not part of the VPC specified.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidPerUnitStorageThroughput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>An invalid value for <code>PerUnitStorageThroughput</code> was provided. Please create your file system again, using a valid value.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"IpAddress":{
|
||||
"type":"string",
|
||||
"max":15,
|
||||
|
|
@ -1410,7 +1427,7 @@
|
|||
},
|
||||
"KmsKeyId":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system at rest. Amazon FSx for Lustre does not support KMS encryption. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html\">Encrypt</a> in the <i>AWS Key Management Service API Reference</i>.</p>",
|
||||
"documentation":"<p>The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems and Amazon FSx for Lustre <code>PERSISTENT_1</code> file systems at rest. In either case, if not specified, the Amazon FSx managed key is used. The Amazon FSx for Lustre <code>SCRATCH_1</code> and <code>SCRATCH_2</code> file systems are always encrypted at rest using Amazon FSx managed keys. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html\">Encrypt</a> in the <i>AWS Key Management Service API Reference</i>.</p>",
|
||||
"max":2048,
|
||||
"min":1,
|
||||
"pattern":"^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}|arn:aws[a-z-]{0,7}:kms:[a-z]{2}-[a-z-]{4,}-\\d+:\\d{12}:(key|alias)\\/([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}|[a-zA-Z0-9:\\/_-]+)|alias\\/[a-zA-Z0-9:\\/_-]+$"
|
||||
|
|
@ -1449,6 +1466,14 @@
|
|||
},
|
||||
"documentation":"<p>The response object for <code>ListTagsForResource</code> operation.</p>"
|
||||
},
|
||||
"LustreDeploymentType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SCRATCH_1",
|
||||
"SCRATCH_2",
|
||||
"PERSISTENT_1"
|
||||
]
|
||||
},
|
||||
"LustreFileSystemConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1456,10 +1481,28 @@
|
|||
"shape":"WeeklyTime",
|
||||
"documentation":"<p>The UTC time that you want to begin your weekly maintenance window.</p>"
|
||||
},
|
||||
"DataRepositoryConfiguration":{"shape":"DataRepositoryConfiguration"}
|
||||
"DataRepositoryConfiguration":{"shape":"DataRepositoryConfiguration"},
|
||||
"DeploymentType":{
|
||||
"shape":"LustreDeploymentType",
|
||||
"documentation":"<p>The deployment type of the FSX for Lustre file system.</p>"
|
||||
},
|
||||
"PerUnitStorageThroughput":{
|
||||
"shape":"PerUnitStorageThroughput",
|
||||
"documentation":"<p> Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for <code>PERSISTENT_1</code> deployment types. Valid values are 50, 100, 200. </p>"
|
||||
},
|
||||
"MountName":{
|
||||
"shape":"LustreFileSystemMountName",
|
||||
"documentation":"<p>You use the <code>MountName</code> value when mounting the file system.</p> <p>For the <code>SCRATCH_1</code> deployment type, this value is always \"<code>fsx</code>\". For <code>SCRATCH_2</code> and <code>PERSISTENT_1</code> deployment types, this value is a string that is unique within an AWS Region. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration for the Amazon FSx for Lustre file system.</p>"
|
||||
},
|
||||
"LustreFileSystemMountName":{
|
||||
"type":"string",
|
||||
"max":8,
|
||||
"min":1,
|
||||
"pattern":"^([A-Za-z0-9_-]{1,8})$"
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"documentation":"<p>The maximum number of resources to return in the response. This value must be an integer greater than zero.</p>",
|
||||
|
|
@ -1481,7 +1524,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>File system configuration is required for this operation.</p>",
|
||||
"documentation":"<p>A file system configuration is required for this operation.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"NetworkInterfaceId":{
|
||||
|
|
@ -1528,6 +1571,11 @@
|
|||
"documentation":"<p>The name of a parameter for the request. Parameter names are returned in PascalCase.</p>",
|
||||
"min":1
|
||||
},
|
||||
"PerUnitStorageThroughput":{
|
||||
"type":"integer",
|
||||
"max":200,
|
||||
"min":50
|
||||
},
|
||||
"ProgressPercent":{
|
||||
"type":"integer",
|
||||
"documentation":"<p>The current percent of progress of an asynchronous task.</p>",
|
||||
|
|
@ -1948,7 +1996,7 @@
|
|||
},
|
||||
"CopyTagsToBackups":{
|
||||
"shape":"Flag",
|
||||
"documentation":"<p>A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups.</p>"
|
||||
"documentation":"<p>A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration for this Microsoft Windows file system.</p>"
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1442,6 +1442,22 @@
|
|||
],
|
||||
"documentation":"<p>Retrieves the names of all job resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.</p> <p>This operation takes the optional <code>Tags</code> field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.</p>"
|
||||
},
|
||||
"ListMLTransforms":{
|
||||
"name":"ListMLTransforms",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListMLTransformsRequest"},
|
||||
"output":{"shape":"ListMLTransformsResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p> Retrieves a sortable, filterable list of existing AWS Glue machine learning transforms in this AWS account, or the resources with the specified tag. This operation takes the optional <code>Tags</code> field, which you can use as a filter of the responses so that tagged resources can be retrieved as a group. If you choose to use tag filtering, only resources with the tags are retrieved. </p>"
|
||||
},
|
||||
"ListTriggers":{
|
||||
"name":"ListTriggers",
|
||||
"http":{
|
||||
|
|
@ -3662,6 +3678,10 @@
|
|||
"shape":"GenericMap",
|
||||
"documentation":"<p>The default arguments for this job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
|
||||
},
|
||||
"NonOverridableArguments":{
|
||||
"shape":"GenericMap",
|
||||
"documentation":"<p>Non-overridable arguments for this job, specified as name-value pairs.</p>"
|
||||
},
|
||||
"Connections":{
|
||||
"shape":"ConnectionsList",
|
||||
"documentation":"<p>The connections used for this job.</p>"
|
||||
|
|
@ -3789,6 +3809,10 @@
|
|||
"MaxRetries":{
|
||||
"shape":"NullableInteger",
|
||||
"documentation":"<p>The maximum number of times to retry a task for this transform after a task run fails.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagsMap",
|
||||
"documentation":"<p>The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue, see <a href=\"https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html\">AWS Tags in AWS Glue</a> in the developer guide.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -6501,6 +6525,10 @@
|
|||
"shape":"GenericMap",
|
||||
"documentation":"<p>The default arguments for this job, specified as name-value pairs.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
|
||||
},
|
||||
"NonOverridableArguments":{
|
||||
"shape":"GenericMap",
|
||||
"documentation":"<p>Non-overridable arguments for this job, specified as name-value pairs.</p>"
|
||||
},
|
||||
"Connections":{
|
||||
"shape":"ConnectionsList",
|
||||
"documentation":"<p>The connections used for this job.</p>"
|
||||
|
|
@ -6777,6 +6805,10 @@
|
|||
"shape":"GenericMap",
|
||||
"documentation":"<p>The default arguments for this job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
|
||||
},
|
||||
"NonOverridableArguments":{
|
||||
"shape":"GenericMap",
|
||||
"documentation":"<p>Non-overridable arguments for this job, specified as name-value pairs.</p>"
|
||||
},
|
||||
"Connections":{
|
||||
"shape":"ConnectionsList",
|
||||
"documentation":"<p>The connections used for this job.</p>"
|
||||
|
|
@ -7010,6 +7042,45 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ListMLTransformsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>A continuation token, if this is a continuation request.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum size of a list to return.</p>"
|
||||
},
|
||||
"Filter":{
|
||||
"shape":"TransformFilterCriteria",
|
||||
"documentation":"<p>A <code>TransformFilterCriteria</code> used to filter the machine learning transforms.</p>"
|
||||
},
|
||||
"Sort":{
|
||||
"shape":"TransformSortCriteria",
|
||||
"documentation":"<p>A <code>TransformSortCriteria</code> used to sort the machine learning transforms.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagsMap",
|
||||
"documentation":"<p>Specifies to return only these tagged resources.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListMLTransformsResponse":{
|
||||
"type":"structure",
|
||||
"required":["TransformIds"],
|
||||
"members":{
|
||||
"TransformIds":{
|
||||
"shape":"TransformIdList",
|
||||
"documentation":"<p>The identifiers of all the machine learning transforms in the account, or the machine learning transforms with the specified tags.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>A continuation token, if the returned list does not contain the last metric available.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTriggersRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -8876,6 +8947,10 @@
|
|||
},
|
||||
"documentation":"<p>The criteria used to filter the machine learning transforms.</p>"
|
||||
},
|
||||
"TransformIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"HashString"}
|
||||
},
|
||||
"TransformList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"MLTransform"}
|
||||
|
|
|
|||
|
|
@ -2460,6 +2460,11 @@
|
|||
"documentation":"<p>The type of the EC2 instance.</p>",
|
||||
"locationName":"instanceType"
|
||||
},
|
||||
"OutpostArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Outpost. Only applicable to AWS Outposts instances.</p>",
|
||||
"locationName":"outpostArn"
|
||||
},
|
||||
"LaunchTime":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The launch time of the EC2 instance.</p>",
|
||||
|
|
@ -2702,7 +2707,7 @@
|
|||
},
|
||||
"FindingCriteria":{
|
||||
"shape":"FindingCriteria",
|
||||
"documentation":"<p>Represents the criteria used for querying findings. Valid values include:</p> <ul> <li> <p>JSON field name</p> </li> <li> <p>accountId</p> </li> <li> <p>region</p> </li> <li> <p>confidence</p> </li> <li> <p>id</p> </li> <li> <p>resource.accessKeyDetails.accessKeyId</p> </li> <li> <p>resource.accessKeyDetails.principalId</p> </li> <li> <p>resource.accessKeyDetails.userName</p> </li> <li> <p>resource.accessKeyDetails.userType</p> </li> <li> <p>resource.instanceDetails.iamInstanceProfile.id</p> </li> <li> <p>resource.instanceDetails.imageId</p> </li> <li> <p>resource.instanceDetails.instanceId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.ipv6Addresses</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicDnsName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicIp</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.subnetId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.vpcId</p> </li> <li> <p>resource.instanceDetails.tags.key</p> </li> <li> <p>resource.instanceDetails.tags.value</p> </li> <li> <p>resource.resourceType</p> </li> <li> <p>service.action.actionType</p> </li> <li> <p>service.action.awsApiCallAction.api</p> </li> <li> <p>service.action.awsApiCallAction.callerType</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.awsApiCallAction.serviceName</p> </li> <li> <p>service.action.dnsRequestAction.domain</p> </li> <li> <p>service.action.networkConnectionAction.blocked</p> </li> <li> <p>service.action.networkConnectionAction.connectionDirection</p> </li> <li> <p>service.action.networkConnectionAction.localPortDetails.port</p> </li> <li> <p>service.action.networkConnectionAction.protocol</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.networkConnectionAction.remotePortDetails.port</p> </li> <li> <p>service.additionalInfo.threatListName</p> </li> <li> <p>service.archived</p> <p>When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.</p> </li> <li> <p>service.resourceRole</p> </li> <li> <p>severity</p> </li> <li> <p>type</p> </li> <li> <p>updatedAt</p> <p>Type: Timestamp in Unix Epoch millisecond format: 1486685375000</p> </li> </ul>",
|
||||
"documentation":"<p>Represents the criteria used for querying findings. Valid values include:</p> <ul> <li> <p>JSON field name</p> </li> <li> <p>accountId</p> </li> <li> <p>region</p> </li> <li> <p>confidence</p> </li> <li> <p>id</p> </li> <li> <p>resource.accessKeyDetails.accessKeyId</p> </li> <li> <p>resource.accessKeyDetails.principalId</p> </li> <li> <p>resource.accessKeyDetails.userName</p> </li> <li> <p>resource.accessKeyDetails.userType</p> </li> <li> <p>resource.instanceDetails.iamInstanceProfile.id</p> </li> <li> <p>resource.instanceDetails.imageId</p> </li> <li> <p>resource.instanceDetails.instanceId</p> </li> <li> <p>resource.instanceDetails.outpostArn</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.ipv6Addresses</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicDnsName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.publicIp</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.securityGroups.groupName</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.subnetId</p> </li> <li> <p>resource.instanceDetails.networkInterfaces.vpcId</p> </li> <li> <p>resource.instanceDetails.tags.key</p> </li> <li> <p>resource.instanceDetails.tags.value</p> </li> <li> <p>resource.resourceType</p> </li> <li> <p>service.action.actionType</p> </li> <li> <p>service.action.awsApiCallAction.api</p> </li> <li> <p>service.action.awsApiCallAction.callerType</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.awsApiCallAction.serviceName</p> </li> <li> <p>service.action.dnsRequestAction.domain</p> </li> <li> <p>service.action.networkConnectionAction.blocked</p> </li> <li> <p>service.action.networkConnectionAction.connectionDirection</p> </li> <li> <p>service.action.networkConnectionAction.localPortDetails.port</p> </li> <li> <p>service.action.networkConnectionAction.protocol</p> </li> <li> <p>service.action.networkConnectionAction.localIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.city.cityName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.country.countryName</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.ipAddressV4</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asn</p> </li> <li> <p>service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg</p> </li> <li> <p>service.action.networkConnectionAction.remotePortDetails.port</p> </li> <li> <p>service.additionalInfo.threatListName</p> </li> <li> <p>service.archived</p> <p>When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.</p> </li> <li> <p>service.resourceRole</p> </li> <li> <p>severity</p> </li> <li> <p>type</p> </li> <li> <p>updatedAt</p> <p>Type: Timestamp in Unix Epoch millisecond format: 1486685375000</p> </li> </ul>",
|
||||
"locationName":"findingCriteria"
|
||||
},
|
||||
"SortCriteria":{
|
||||
|
|
@ -2957,6 +2962,17 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"LocalIpDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"IpAddressV4":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>IPV4 remote address of the connection.</p>",
|
||||
"locationName":"ipAddressV4"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the local IP address of the connection.</p>"
|
||||
},
|
||||
"LocalPortDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3096,6 +3112,11 @@
|
|||
"documentation":"<p>Network connection protocol.</p>",
|
||||
"locationName":"protocol"
|
||||
},
|
||||
"LocalIpDetails":{
|
||||
"shape":"LocalIpDetails",
|
||||
"documentation":"<p>Local IP information of the connection.</p>",
|
||||
"locationName":"localIpDetails"
|
||||
},
|
||||
"RemoteIpDetails":{
|
||||
"shape":"RemoteIpDetails",
|
||||
"documentation":"<p>Remote IP information of the connection.</p>",
|
||||
|
|
@ -3230,6 +3251,11 @@
|
|||
"documentation":"<p>Local port information of the connection.</p>",
|
||||
"locationName":"localPortDetails"
|
||||
},
|
||||
"LocalIpDetails":{
|
||||
"shape":"LocalIpDetails",
|
||||
"documentation":"<p>Local IP information of the connection.</p>",
|
||||
"locationName":"localIpDetails"
|
||||
},
|
||||
"RemoteIpDetails":{
|
||||
"shape":"RemoteIpDetails",
|
||||
"documentation":"<p>Remote IP information of the connection.</p>",
|
||||
|
|
|
|||
|
|
@ -1887,7 +1887,7 @@
|
|||
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
|
||||
},
|
||||
"policy":{
|
||||
"shape":"NonEmptyString",
|
||||
"shape":"ResourcePolicyDocument",
|
||||
"documentation":"<p> The component policy. </p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -1987,7 +1987,7 @@
|
|||
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
|
||||
},
|
||||
"policy":{
|
||||
"shape":"NonEmptyString",
|
||||
"shape":"ResourcePolicyDocument",
|
||||
"documentation":"<p> The image policy object. </p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -2012,7 +2012,7 @@
|
|||
"documentation":"<p> The request ID that uniquely identifies this request. </p>"
|
||||
},
|
||||
"policy":{
|
||||
"shape":"NonEmptyString",
|
||||
"shape":"ResourcePolicyDocument",
|
||||
"documentation":"<p> The image recipe policy object. </p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -3181,7 +3181,7 @@
|
|||
"documentation":"<p> The Amazon Resource Name (ARN) of the component that this policy should be applied to. </p>"
|
||||
},
|
||||
"policy":{
|
||||
"shape":"NonEmptyString",
|
||||
"shape":"ResourcePolicyDocument",
|
||||
"documentation":"<p> The policy to apply. </p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -3211,7 +3211,7 @@
|
|||
"documentation":"<p> The Amazon Resource Name (ARN) of the image that this policy should be applied to. </p>"
|
||||
},
|
||||
"policy":{
|
||||
"shape":"NonEmptyString",
|
||||
"shape":"ResourcePolicyDocument",
|
||||
"documentation":"<p> The policy to apply. </p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -3241,7 +3241,7 @@
|
|||
"documentation":"<p> The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to. </p>"
|
||||
},
|
||||
"policy":{
|
||||
"shape":"NonEmptyString",
|
||||
"shape":"ResourcePolicyDocument",
|
||||
"documentation":"<p> The policy to apply. </p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -3299,6 +3299,11 @@
|
|||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"ResourcePolicyDocument":{
|
||||
"type":"string",
|
||||
"max":30000,
|
||||
"min":1
|
||||
},
|
||||
"RestrictedInteger":{
|
||||
"type":"integer",
|
||||
"max":25,
|
||||
|
|
|
|||
|
|
@ -615,7 +615,7 @@
|
|||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a <code>ResourceAlreadyExistsException</code> is thrown.</p> <note> <p>This is a control plane operation. See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
|
||||
"documentation":"<p>Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a <code>ResourceAlreadyExistsException</code> is thrown.</p> <note> <p>This is a control plane operation. See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
|
||||
},
|
||||
"CreateThingGroup":{
|
||||
"name":"CreateThingGroup",
|
||||
|
|
@ -631,7 +631,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Create a thing group.</p> <note> <p>This is a control plane operation. See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
|
||||
"documentation":"<p>Create a thing group.</p> <note> <p>This is a control plane operation. See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
|
||||
},
|
||||
"CreateThingType":{
|
||||
"name":"CreateThingType",
|
||||
|
|
@ -3573,6 +3573,10 @@
|
|||
"shape":"CloudwatchAlarmAction",
|
||||
"documentation":"<p>Change the state of a CloudWatch alarm.</p>"
|
||||
},
|
||||
"cloudwatchLogs":{
|
||||
"shape":"CloudwatchLogsAction",
|
||||
"documentation":"<p>Send data to CloudWatch logs.</p>"
|
||||
},
|
||||
"elasticsearch":{
|
||||
"shape":"ElasticsearchAction",
|
||||
"documentation":"<p>Write data to an Amazon Elasticsearch Service domain.</p>"
|
||||
|
|
@ -5110,6 +5114,24 @@
|
|||
},
|
||||
"documentation":"<p>Describes an action that updates a CloudWatch alarm.</p>"
|
||||
},
|
||||
"CloudwatchLogsAction":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"roleArn",
|
||||
"logGroupName"
|
||||
],
|
||||
"members":{
|
||||
"roleArn":{
|
||||
"shape":"AwsArn",
|
||||
"documentation":"<p>The IAM role that allows access to the CloudWatch log.</p>"
|
||||
},
|
||||
"logGroupName":{
|
||||
"shape":"LogGroupName",
|
||||
"documentation":"<p>The CloudWatch log group to which the action sends data.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes an action that sends data to CloudWatch logs.</p>"
|
||||
},
|
||||
"CloudwatchMetricAction":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -7218,7 +7240,7 @@
|
|||
"members":{
|
||||
"endpointType":{
|
||||
"shape":"EndpointType",
|
||||
"documentation":"<p>The endpoint type. Valid endpoint types include:</p> <ul> <li> <p> <code>iot:Data</code> - Returns a VeriSign signed data endpoint.</p> </li> </ul> <ul> <li> <p> <code>iot:Data-ATS</code> - Returns an ATS signed data endpoint.</p> </li> </ul> <ul> <li> <p> <code>iot:CredentialProvider</code> - Returns an AWS IoT credentials provider API endpoint.</p> </li> </ul> <ul> <li> <p> <code>iot:Jobs</code> - Returns an AWS IoT device management Jobs API endpoint.</p> </li> </ul>",
|
||||
"documentation":"<p>The endpoint type. Valid endpoint types include:</p> <ul> <li> <p> <code>iot:Data</code> - Returns a VeriSign signed data endpoint.</p> </li> </ul> <ul> <li> <p> <code>iot:Data-ATS</code> - Returns an ATS signed data endpoint.</p> </li> </ul> <ul> <li> <p> <code>iot:CredentialProvider</code> - Returns an AWS IoT credentials provider API endpoint.</p> </li> </ul> <ul> <li> <p> <code>iot:Jobs</code> - Returns an AWS IoT device management Jobs API endpoint.</p> </li> </ul> <p>We strongly recommend that customers use the newer <code>iot:Data-ATS</code> endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"endpointType"
|
||||
}
|
||||
|
|
@ -11458,6 +11480,7 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"LogGroupName":{"type":"string"},
|
||||
"LogLevel":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -12403,7 +12426,7 @@
|
|||
"members":{
|
||||
"templateBody":{
|
||||
"shape":"TemplateBody",
|
||||
"documentation":"<p>The provisioning template. See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/programmatic-provisioning.html\">Programmatic Provisioning</a> for more information.</p>"
|
||||
"documentation":"<p>The provisioning template. See <a href=\"https://docs.aws.amazon.com/iot/latest/developerguide/provision-w-cert.html\">Provisioning Devices That Have Device Certificates</a> for more information.</p>"
|
||||
},
|
||||
"parameters":{
|
||||
"shape":"Parameters",
|
||||
|
|
@ -14777,7 +14800,7 @@
|
|||
},
|
||||
"newStatus":{
|
||||
"shape":"CertificateStatus",
|
||||
"documentation":"<p>The new status.</p> <p> <b>Note:</b> Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use.</p> <p> <b>Note:</b> The status value REGISTER_INACTIVE is deprecated and should not be used.</p>",
|
||||
"documentation":"<p>The new status.</p> <p> <b>Note:</b> Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by AWS IoT. They are not intended for developer use.</p> <p> <b>Note:</b> The status value REGISTER_INACTIVE is deprecated and should not be used.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"newStatus"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"ServiceUnavailableException"}
|
||||
],
|
||||
"documentation":"<p>Describes a detector model. If the <code>\"version\"</code> parameter is not specified, information about the latest version is returned.</p>"
|
||||
"documentation":"<p>Describes a detector model. If the <code>version</code> parameter is not specified, information about the latest version is returned.</p>"
|
||||
},
|
||||
"DescribeInput":{
|
||||
"name":"DescribeInput",
|
||||
|
|
@ -218,7 +218,7 @@
|
|||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"ResourceInUseException"}
|
||||
],
|
||||
"documentation":"<p>Sets or updates the AWS IoT Events logging options.</p> <p>If you update the value of any <code>\"loggingOptions\"</code> field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the <code>\"roleArn\"</code> field (for example, to correct an invalid policy) it takes up to five minutes for that change to take effect.</p>"
|
||||
"documentation":"<p>Sets or updates the AWS IoT Events logging options.</p> <p>If you update the value of any <code>loggingOptions</code> field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the <code>roleArn</code> field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.</p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
|
|
@ -326,7 +326,7 @@
|
|||
},
|
||||
"iotEvents":{
|
||||
"shape":"IotEventsAction",
|
||||
"documentation":"<p>Sends an IoT Events input, passing in information about the detector model instance and the event that triggered the action.</p>"
|
||||
"documentation":"<p>Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.</p>"
|
||||
},
|
||||
"sqs":{
|
||||
"shape":"SqsAction",
|
||||
|
|
@ -334,10 +334,10 @@
|
|||
},
|
||||
"firehose":{
|
||||
"shape":"FirehoseAction",
|
||||
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to a Kinesis Data Firehose delivery stream.</p>"
|
||||
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An action to be performed when the <code>\"condition\"</code> is TRUE.</p>"
|
||||
"documentation":"<p>An action to be performed when the <code>condition</code> is TRUE.</p>"
|
||||
},
|
||||
"Actions":{
|
||||
"type":"list",
|
||||
|
|
@ -354,10 +354,10 @@
|
|||
"members":{
|
||||
"jsonPath":{
|
||||
"shape":"AttributeJsonPath",
|
||||
"documentation":"<p>An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to the AWS IoT Events system (<code>BatchPutMessage</code>). Each such message contains a JSON payload, and the attribute (and its paired value) specified here are available for use in the <code>\"condition\"</code> expressions used by detectors. </p> <p>Syntax: <code><field-name>.<field-name>...</code> </p>"
|
||||
"documentation":"<p>An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (<code>BatchPutMessage</code>). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the <code>condition</code> expressions used by detectors. </p> <p>Syntax: <code><field-name>.<field-name>...</code> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the <code>condition</code> expressions used by detectors. </p>"
|
||||
"documentation":"<p>The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the <code>condition</code> expressions used by detectors. </p>"
|
||||
},
|
||||
"AttributeJsonPath":{
|
||||
"type":"string",
|
||||
|
|
@ -408,7 +408,7 @@
|
|||
},
|
||||
"key":{
|
||||
"shape":"AttributeJsonPath",
|
||||
"documentation":"<p>The input attribute key used to identify a device or system in order to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to identify the device associated with the input.</p>"
|
||||
"documentation":"<p>The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.</p>"
|
||||
},
|
||||
"roleArn":{
|
||||
"shape":"AmazonResourceName",
|
||||
|
|
@ -636,7 +636,7 @@
|
|||
},
|
||||
"key":{
|
||||
"shape":"AttributeJsonPath",
|
||||
"documentation":"<p>The input attribute key used to identify a device or system in order to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to identify the device associated with the input.</p>"
|
||||
"documentation":"<p>The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.</p>"
|
||||
},
|
||||
"evaluationMethod":{
|
||||
"shape":"EvaluationMethod",
|
||||
|
|
@ -771,14 +771,14 @@
|
|||
},
|
||||
"condition":{
|
||||
"shape":"Condition",
|
||||
"documentation":"<p>[Optional] The Boolean expression that when TRUE causes the <code>\"actions\"</code> to be performed. If not present, the actions are performed (=TRUE); if the expression result is not a Boolean value, the actions are NOT performed (=FALSE).</p>"
|
||||
"documentation":"<p>Optional. The Boolean expression that, when TRUE, causes the <code>actions</code> to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).</p>"
|
||||
},
|
||||
"actions":{
|
||||
"shape":"Actions",
|
||||
"documentation":"<p>The actions to be performed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies the <code>\"actions\"</code> to be performed when the <code>\"condition\"</code> evaluates to TRUE.</p>"
|
||||
"documentation":"<p>Specifies the <code>actions</code> to be performed when the <code>condition</code> evaluates to TRUE.</p>"
|
||||
},
|
||||
"EventName":{
|
||||
"type":"string",
|
||||
|
|
@ -801,7 +801,7 @@
|
|||
"documentation":"<p>A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to a Kinesis Data Firehose delivery stream.</p>"
|
||||
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.</p>"
|
||||
},
|
||||
"FirehoseSeparator":{
|
||||
"type":"string",
|
||||
|
|
@ -865,7 +865,7 @@
|
|||
"members":{
|
||||
"attributes":{
|
||||
"shape":"Attributes",
|
||||
"documentation":"<p>The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the <code>\"condition\"</code> expressions used by detectors that monitor this input. </p>"
|
||||
"documentation":"<p>The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the <code>condition</code> expressions used by detectors that monitor this input. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The definition of the input.</p>"
|
||||
|
|
@ -965,10 +965,10 @@
|
|||
"members":{
|
||||
"mqttTopic":{
|
||||
"shape":"MQTTTopic",
|
||||
"documentation":"<p>The MQTT topic of the message.</p>"
|
||||
"documentation":"<p>The MQTT topic of the message. You can use a string expression that includes variables (<code>$variable.<variable-name></code>) and input values (<code>$input.<input-name>.<path-to-datum></code>) as the topic string.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information required to publish the MQTT message via the AWS IoT message broker.</p>"
|
||||
"documentation":"<p>Information required to publish the MQTT message through the AWS IoT message broker.</p>"
|
||||
},
|
||||
"KeyValue":{
|
||||
"type":"string",
|
||||
|
|
@ -1169,7 +1169,7 @@
|
|||
"members":{
|
||||
"events":{
|
||||
"shape":"Events",
|
||||
"documentation":"<p>Specifies the actions that are performed when the state is entered and the <code>\"condition\"</code> is TRUE.</p>"
|
||||
"documentation":"<p>Specifies the actions that are performed when the state is entered and the <code>condition</code> is TRUE.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>When entering this state, perform these <code>actions</code> if the <code>condition</code> is TRUE.</p>"
|
||||
|
|
@ -1179,24 +1179,24 @@
|
|||
"members":{
|
||||
"events":{
|
||||
"shape":"Events",
|
||||
"documentation":"<p>Specifies the <code>\"actions\"</code> that are performed when the state is exited and the <code>\"condition\"</code> is TRUE.</p>"
|
||||
"documentation":"<p>Specifies the <code>actions</code> that are performed when the state is exited and the <code>condition</code> is TRUE.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>When exiting this state, perform these <code>\"actions\"</code> if the specified <code>\"condition\"</code> is TRUE.</p>"
|
||||
"documentation":"<p>When exiting this state, perform these <code>actions</code> if the specified <code>condition</code> is TRUE.</p>"
|
||||
},
|
||||
"OnInputLifecycle":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"events":{
|
||||
"shape":"Events",
|
||||
"documentation":"<p>Specifies the actions performed when the <code>\"condition\"</code> evaluates to TRUE.</p>"
|
||||
"documentation":"<p>Specifies the actions performed when the <code>condition</code> evaluates to TRUE.</p>"
|
||||
},
|
||||
"transitionEvents":{
|
||||
"shape":"TransitionEvents",
|
||||
"documentation":"<p>Specifies the actions performed, and the next state entered, when a <code>\"condition\"</code> evaluates to TRUE.</p>"
|
||||
"documentation":"<p>Specifies the actions performed, and the next state entered, when a <code>condition</code> evaluates to TRUE.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies the actions performed when the <code>\"condition\"</code> evaluates to TRUE.</p>"
|
||||
"documentation":"<p>Specifies the actions performed when the <code>condition</code> evaluates to TRUE.</p>"
|
||||
},
|
||||
"PutLoggingOptionsRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1218,7 +1218,7 @@
|
|||
"documentation":"<p>The name of the timer to reset.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information needed to reset the timer.</p>"
|
||||
"documentation":"<p>Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. </p>"
|
||||
},
|
||||
"ResourceAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
|
|
@ -1275,7 +1275,11 @@
|
|||
},
|
||||
"documentation":"<p>Information required to publish the Amazon SNS message.</p>"
|
||||
},
|
||||
"Seconds":{"type":"integer"},
|
||||
"Seconds":{
|
||||
"type":"integer",
|
||||
"max":31622400,
|
||||
"min":1
|
||||
},
|
||||
"ServiceUnavailableException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1291,10 +1295,7 @@
|
|||
},
|
||||
"SetTimerAction":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"timerName",
|
||||
"seconds"
|
||||
],
|
||||
"required":["timerName"],
|
||||
"members":{
|
||||
"timerName":{
|
||||
"shape":"TimerName",
|
||||
|
|
@ -1302,7 +1303,13 @@
|
|||
},
|
||||
"seconds":{
|
||||
"shape":"Seconds",
|
||||
"documentation":"<p>The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy.</p>"
|
||||
"documentation":"<p>The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy.</p>",
|
||||
"deprecated":true,
|
||||
"deprecatedMessage":"seconds is deprecated. You can use durationExpression for SetTimerAction. The value of seconds can be used as a string expression for durationExpression."
|
||||
},
|
||||
"durationExpression":{
|
||||
"shape":"VariableValue",
|
||||
"documentation":"<p>The duration of the timer, in seconds. You can use a string expression that includes numbers, variables (<code>$variable.<variable-name></code>), and input values (<code>$input.<input-name>.<path-to-datum></code>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information needed to set the timer.</p>"
|
||||
|
|
@ -1335,7 +1342,7 @@
|
|||
},
|
||||
"useBase64":{
|
||||
"shape":"UseBase64",
|
||||
"documentation":"<p>Set this to TRUE if you want the data to be Base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.</p>"
|
||||
"documentation":"<p>Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.</p>"
|
||||
|
|
@ -1350,15 +1357,15 @@
|
|||
},
|
||||
"onInput":{
|
||||
"shape":"OnInputLifecycle",
|
||||
"documentation":"<p>When an input is received and the <code>\"condition\"</code> is TRUE, perform the specified <code>\"actions\"</code>.</p>"
|
||||
"documentation":"<p>When an input is received and the <code>condition</code> is TRUE, perform the specified <code>actions</code>.</p>"
|
||||
},
|
||||
"onEnter":{
|
||||
"shape":"OnEnterLifecycle",
|
||||
"documentation":"<p>When entering this state, perform these <code>\"actions\"</code> if the <code>\"condition\"</code> is TRUE.</p>"
|
||||
"documentation":"<p>When entering this state, perform these <code>actions</code> if the <code>condition</code> is TRUE.</p>"
|
||||
},
|
||||
"onExit":{
|
||||
"shape":"OnExitLifecycle",
|
||||
"documentation":"<p>When exiting this state, perform these <code>\"actions\"</code> if the specified <code>\"condition\"</code> is TRUE.</p>"
|
||||
"documentation":"<p>When exiting this state, perform these <code>actions</code> if the specified <code>condition</code> is TRUE.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information that defines a state of a detector.</p>"
|
||||
|
|
@ -1465,7 +1472,7 @@
|
|||
},
|
||||
"condition":{
|
||||
"shape":"Condition",
|
||||
"documentation":"<p>[Required] A Boolean expression that when TRUE causes the actions to be performed and the <code>\"nextState\"</code> to be entered.</p>"
|
||||
"documentation":"<p>Required. A Boolean expression that when TRUE causes the actions to be performed and the <code>nextState</code> to be entered.</p>"
|
||||
},
|
||||
"actions":{
|
||||
"shape":"Actions",
|
||||
|
|
@ -1476,7 +1483,7 @@
|
|||
"documentation":"<p>The next state to enter.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies the actions performed and the next state entered when a <code>\"condition\"</code> evaluates to TRUE.</p>"
|
||||
"documentation":"<p>Specifies the actions performed and the next state entered when a <code>condition</code> evaluates to TRUE.</p>"
|
||||
},
|
||||
"TransitionEvents":{
|
||||
"type":"list",
|
||||
|
|
@ -1610,5 +1617,5 @@
|
|||
"resourceArn":{"type":"string"},
|
||||
"resourceId":{"type":"string"}
|
||||
},
|
||||
"documentation":"<p>AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. AWS IoT Events API commands enable you to create, read, update and delete inputs and detector models, and to list their versions.</p>"
|
||||
"documentation":"<p>AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API commands to create, read, update, and delete inputs and detector models, and to list their versions.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -831,6 +831,23 @@
|
|||
"KafkaBrokerNodeId"
|
||||
]
|
||||
},
|
||||
"BrokerLogs": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CloudWatchLogs": {
|
||||
"shape": "CloudWatchLogs",
|
||||
"locationName": "cloudWatchLogs"
|
||||
},
|
||||
"Firehose": {
|
||||
"shape": "Firehose",
|
||||
"locationName": "firehose"
|
||||
},
|
||||
"S3": {
|
||||
"shape": "S3",
|
||||
"locationName": "s3"
|
||||
}
|
||||
}
|
||||
},
|
||||
"BrokerNodeGroupInfo": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -943,6 +960,20 @@
|
|||
"PLAINTEXT"
|
||||
]
|
||||
},
|
||||
"CloudWatchLogs" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
"Enabled" : {
|
||||
"shape" : "__boolean",
|
||||
"locationName" : "enabled"
|
||||
},
|
||||
"LogGroup" : {
|
||||
"shape" : "__string",
|
||||
"locationName" : "logGroup"
|
||||
}
|
||||
},
|
||||
"required" : [ "Enabled" ]
|
||||
},
|
||||
"ClusterInfo": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1001,6 +1032,10 @@
|
|||
"locationName" : "openMonitoring",
|
||||
"documentation" : "\n <p>Settings for open monitoring using Prometheus.</p>\n "
|
||||
},
|
||||
"LoggingInfo": {
|
||||
"shape": "LoggingInfo",
|
||||
"locationName": "loggingInfo"
|
||||
},
|
||||
"NumberOfBrokerNodes": {
|
||||
"shape": "__integer",
|
||||
"locationName": "numberOfBrokerNodes",
|
||||
|
|
@ -1247,6 +1282,10 @@
|
|||
"locationName": "kafkaVersion",
|
||||
"documentation": "\n <p>The version of Apache Kafka.</p>\n "
|
||||
},
|
||||
"LoggingInfo": {
|
||||
"shape": "LoggingInfo",
|
||||
"locationName": "loggingInfo"
|
||||
},
|
||||
"NumberOfBrokerNodes": {
|
||||
"shape": "__integerMin1Max15",
|
||||
"locationName": "numberOfBrokerNodes",
|
||||
|
|
@ -1621,6 +1660,20 @@
|
|||
},
|
||||
"documentation": "\n <p>Returns information about an error state of the cluster.</p>\n "
|
||||
},
|
||||
"Firehose" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
"DeliveryStream" : {
|
||||
"shape" : "__string",
|
||||
"locationName" : "deliveryStream"
|
||||
},
|
||||
"Enabled" : {
|
||||
"shape" : "__boolean",
|
||||
"locationName" : "enabled"
|
||||
}
|
||||
},
|
||||
"required" : [ "Enabled" ]
|
||||
},
|
||||
"ForbiddenException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1962,6 +2015,16 @@
|
|||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"LoggingInfo": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"BrokerLogs": {
|
||||
"shape": "BrokerLogs",
|
||||
"locationName": "brokerLogs"
|
||||
}
|
||||
},
|
||||
"required": [ "BrokerLogs" ]
|
||||
},
|
||||
"MutableClusterInfo": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1989,7 +2052,11 @@
|
|||
"shape" : "OpenMonitoring",
|
||||
"locationName" : "openMonitoring",
|
||||
"documentation" : "\n <p>The settings for open monitoring.</p>\n "
|
||||
}
|
||||
},
|
||||
"LoggingInfo": {
|
||||
"shape": "LoggingInfo",
|
||||
"locationName": "loggingInfo"
|
||||
}
|
||||
},
|
||||
"documentation": "\n <p>Information about cluster attributes that can be updated via update APIs.</p>\n "
|
||||
},
|
||||
|
|
@ -2097,6 +2164,24 @@
|
|||
},
|
||||
"documentation" : "\n <p>Prometheus settings.</p>\n "
|
||||
},
|
||||
"S3" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
"Bucket" : {
|
||||
"shape" : "__string",
|
||||
"locationName" : "bucket"
|
||||
},
|
||||
"Enabled" : {
|
||||
"shape" : "__boolean",
|
||||
"locationName" : "enabled"
|
||||
},
|
||||
"Prefix" : {
|
||||
"shape" : "__string",
|
||||
"locationName" : "prefix"
|
||||
}
|
||||
},
|
||||
"required" : [ "Enabled" ]
|
||||
},
|
||||
"NodeInfo": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -2442,6 +2527,10 @@
|
|||
"shape" : "OpenMonitoringInfo",
|
||||
"locationName" : "openMonitoring",
|
||||
"documentation" : "\n <p>The settings for open monitoring.</p>\n "
|
||||
},
|
||||
"LoggingInfo": {
|
||||
"shape": "LoggingInfo",
|
||||
"locationName": "loggingInfo"
|
||||
}
|
||||
},
|
||||
"documentation" : "Request body for UpdateMonitoring.",
|
||||
|
|
|
|||
|
|
@ -301,7 +301,7 @@
|
|||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"ServiceException"}
|
||||
],
|
||||
"documentation":"<p>Returns details about the concurrency configuration for a function. To set a concurrency limit for a function, use <a>PutFunctionConcurrency</a>.</p>"
|
||||
"documentation":"<p>Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use <a>PutFunctionConcurrency</a>.</p>"
|
||||
},
|
||||
"GetFunctionConfiguration":{
|
||||
"name":"GetFunctionConfiguration",
|
||||
|
|
@ -541,7 +541,7 @@
|
|||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of Lambda functions, with the version-specific configuration of each.</p> <p>Set <code>FunctionVersion</code> to <code>ALL</code> to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use <a>GetFunction</a>.</p>"
|
||||
"documentation":"<p>Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.</p> <p>Set <code>FunctionVersion</code> to <code>ALL</code> to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use <a>GetFunction</a>.</p>"
|
||||
},
|
||||
"ListLayerVersions":{
|
||||
"name":"ListLayerVersions",
|
||||
|
|
@ -624,7 +624,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"TooManyRequestsException"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html\">versions</a>, with the version-specific configuration of each. </p>"
|
||||
"documentation":"<p>Returns a list of <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html\">versions</a>, with the version-specific configuration of each. Lambda returns up to 50 versions per call.</p>"
|
||||
},
|
||||
"PublishLayerVersion":{
|
||||
"name":"PublishLayerVersion",
|
||||
|
|
@ -697,7 +697,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"TooManyRequestsException"}
|
||||
],
|
||||
"documentation":"<p>Configures options for <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html\">asynchronous invocation</a> on a function, version, or alias.</p> <p>By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with <a>UpdateFunctionConfiguration</a>.</p>"
|
||||
"documentation":"<p>Configures options for <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html\">asynchronous invocation</a> on a function, version, or alias. If a configuration already exists for a function, version, or alias, this operation overwrites it. If you exclude any settings, they are removed. To set one option without affecting existing settings for other options, use <a>PutFunctionEventInvokeConfig</a>.</p> <p>By default, Lambda retries an asynchronous invocation twice if the function returns an error. It retains events in a queue for up to six hours. When an event fails all processing attempts or stays in the asynchronous invocation queue for too long, Lambda discards it. To retain discarded events, configure a dead-letter queue with <a>UpdateFunctionConfiguration</a>.</p> <p>To send an invocation record to a queue, topic, function, or event bus, specify a <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations\">destination</a>. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue.</p>"
|
||||
},
|
||||
"PutProvisionedConcurrencyConfig":{
|
||||
"name":"PutProvisionedConcurrencyConfig",
|
||||
|
|
@ -2728,7 +2728,7 @@
|
|||
},
|
||||
"MaxItems":{
|
||||
"shape":"MaxListItems",
|
||||
"documentation":"<p>Specify a value between 1 and 50 to limit the number of functions in the response.</p>",
|
||||
"documentation":"<p>The maximum number of functions to return.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
}
|
||||
|
|
@ -2903,7 +2903,7 @@
|
|||
},
|
||||
"MaxItems":{
|
||||
"shape":"MaxListItems",
|
||||
"documentation":"<p>Limit the number of versions that are returned.</p>",
|
||||
"documentation":"<p>The maximum number of versions to return.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
}
|
||||
|
|
@ -3487,6 +3487,7 @@
|
|||
"nodejs4.3-edge",
|
||||
"go1.x",
|
||||
"ruby2.5",
|
||||
"ruby2.7",
|
||||
"provided"
|
||||
]
|
||||
},
|
||||
|
|
|
|||
|
|
@ -546,6 +546,23 @@
|
|||
],
|
||||
"documentation":"<p>Use the <code>GetUtterancesView</code> operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.</p> <p>For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the <code>GetUtterancesView</code> operation to see the requests that they have made and whether they have been successful. You might find that the utterance \"I want flowers\" is not being recognized. You could add this utterance to the <code>OrderFlowers</code> intent so that your bot recognizes that utterance.</p> <p>After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. </p> <p>Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.</p> <p>If you set <code>childDirected</code> field to true when you created your bot, or if you opted out of participating in improving Amazon Lex, utterances are not available.</p> <p>This operation requires permissions for the <code>lex:GetUtterancesView</code> action.</p>"
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/tags/{resourceArn}",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"ListTagsForResourceRequest"},
|
||||
"output":{"shape":"ListTagsForResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.</p>"
|
||||
},
|
||||
"PutBot":{
|
||||
"name":"PutBot",
|
||||
"http":{
|
||||
|
|
@ -633,6 +650,42 @@
|
|||
{"shape":"BadRequestException"}
|
||||
],
|
||||
"documentation":"<p>Starts a job to import a resource to Amazon Lex.</p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/tags/{resourceArn}",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"TagResourceRequest"},
|
||||
"output":{"shape":"TagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.</p>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/tags/{resourceArn}",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"UntagResourceRequest"},
|
||||
"output":{"shape":"UntagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Removes tags from a bot, bot alias or bot channel.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -648,6 +701,11 @@
|
|||
"min":1,
|
||||
"pattern":"^(-|^([A-Za-z]_?)+$)$"
|
||||
},
|
||||
"AmazonResourceName":{
|
||||
"type":"string",
|
||||
"max":1011,
|
||||
"min":1
|
||||
},
|
||||
"BadRequestException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2513,6 +2571,27 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"UtteranceData"}
|
||||
},
|
||||
"ListTagsForResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["resourceArn"],
|
||||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"AmazonResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to get a list of tags for.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The tags associated with a resource.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListsOfUtterances":{
|
||||
"type":"list",
|
||||
"member":{"shape":"UtteranceList"}
|
||||
|
|
@ -2755,6 +2834,10 @@
|
|||
"conversationLogs":{
|
||||
"shape":"ConversationLogsRequest",
|
||||
"documentation":"<p>Settings for conversation logs for the alias.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the <code>PutBotAlias</code> operation to update the tags on a bot alias. To update tags, use the <code>TagResource</code> operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2792,6 +2875,10 @@
|
|||
"conversationLogs":{
|
||||
"shape":"ConversationLogsResponse",
|
||||
"documentation":"<p>The settings that determine how Amazon Lex uses conversation logs for the alias.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A list of tags associated with a bot.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2856,6 +2943,10 @@
|
|||
"createVersion":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>When set to <code>true</code> a new numbered version of the bot is created. This is the same as calling the <code>CreateBotVersion</code> operation. If you don't specify <code>createVersion</code>, the default is <code>false</code>.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A list of tags to add to the bot. You can only add tags when you create a bot, you can't use the <code>PutBot</code> operation to update the tags on a bot. To update tags, use the <code>TagResource</code> operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2929,6 +3020,10 @@
|
|||
"detectSentiment":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p> <code>true</code> if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the <code>detectSentiment</code> field was not specified in the request, the <code>detectSentiment</code> field is <code>false</code> in the response.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A list of tags associated with the bot.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3380,6 +3475,10 @@
|
|||
"mergeStrategy":{
|
||||
"shape":"MergeStrategy",
|
||||
"documentation":"<p>Specifies the action that the <code>StartImport</code> operation should take when there is an existing resource with the same name.</p> <ul> <li> <p>FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the <code>failureReason</code> field of the response to the <code>GetImport</code> operation.</p> <p>OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.</p> </li> </ul>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A list of tags to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3406,6 +3505,10 @@
|
|||
"shape":"ImportStatus",
|
||||
"documentation":"<p>The status of the import job. If the status is <code>FAILED</code>, you can get the reason for the failure using the <code>GetImport</code> operation.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A list of tags added to the imported bot.</p>"
|
||||
},
|
||||
"createdDate":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>A timestamp for the date and time that the import job was requested.</p>"
|
||||
|
|
@ -3453,7 +3556,97 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Value"}
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"key",
|
||||
"value"
|
||||
],
|
||||
"members":{
|
||||
"key":{
|
||||
"shape":"TagKey",
|
||||
"documentation":"<p>The key for the tag. Keys are not case-sensitive and must be unique.</p>"
|
||||
},
|
||||
"value":{
|
||||
"shape":"TagValue",
|
||||
"documentation":"<p>The value associated with a key. The value may be an empty string but it can't be null.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A list of key/value pairs that identify a bot, bot alias, or bot channel. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. </p>"
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1
|
||||
},
|
||||
"TagKeyList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TagKey"},
|
||||
"max":200,
|
||||
"min":0
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Tag"},
|
||||
"max":200,
|
||||
"min":0
|
||||
},
|
||||
"TagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"resourceArn",
|
||||
"tags"
|
||||
],
|
||||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"AmazonResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A list of tag keys to add to the resource. If a tag key already exists, the existing value is replaced with the new value.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"TagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"UntagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"resourceArn",
|
||||
"tagKeys"
|
||||
],
|
||||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"AmazonResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to remove the tags from.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
},
|
||||
"tagKeys":{
|
||||
"shape":"TagKeyList",
|
||||
"documentation":"<p>A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"tagKeys"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UntagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UserId":{
|
||||
"type":"string",
|
||||
"max":100,
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -105,7 +105,7 @@
|
|||
},
|
||||
"dataSetPublicationDate":{
|
||||
"shape":"DataSetPublicationDate",
|
||||
"documentation":"The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For weekly data sets, provide a date with day-level granularity within the desired week (the day value will be ignored). For monthly data sets, provide a date with month-level granularity for the desired month (the day value will be ignored)."
|
||||
"documentation":"The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For monthly data sets except those with prefix disbursed_amount, provide a date with month-level granularity for the desired month (the day value will be ignored). For data sets with prefix disbursed_amount, provide a date with day-level granularity for the desired day. For these data sets we will look backwards in time over the range of 31 days until the first data set is found (the latest one)."
|
||||
},
|
||||
"roleNameArn":{
|
||||
"shape":"RoleNameArn",
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
"errors": [
|
||||
{
|
||||
"shape": "AddFlowOutputs420Exception",
|
||||
"documentation": "AWS Elemental MediaConnect can't complete this request because this flow already has the maximum number of allowed outputs (20). For more information, contact AWS Customer Support."
|
||||
"documentation": "AWS Elemental MediaConnect can't complete this request because this flow already has the maximum number of allowed outputs (50). For more information, contact AWS Customer Support."
|
||||
},
|
||||
{
|
||||
"shape": "BadRequestException",
|
||||
|
|
@ -55,7 +55,49 @@
|
|||
"documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
|
||||
}
|
||||
],
|
||||
"documentation": "Adds outputs to an existing flow. You can create up to 20 outputs per flow."
|
||||
"documentation": "Adds outputs to an existing flow. You can create up to 50 outputs per flow."
|
||||
},
|
||||
"AddFlowSources": {
|
||||
"name": "AddFlowSources",
|
||||
"http": {
|
||||
"method": "POST",
|
||||
"requestUri": "/v1/flows/{flowArn}/source",
|
||||
"responseCode": 201
|
||||
},
|
||||
"input": {
|
||||
"shape": "AddFlowSourcesRequest"
|
||||
},
|
||||
"output": {
|
||||
"shape": "AddFlowSourcesResponse",
|
||||
"documentation": "AWS Elemental MediaConnect added sources to the flow successfully."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException",
|
||||
"documentation": "The request that you submitted is not valid."
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException",
|
||||
"documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "You don't have the required permissions to perform this operation."
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException",
|
||||
"documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request."
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException",
|
||||
"documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later."
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException",
|
||||
"documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
|
||||
}
|
||||
],
|
||||
"documentation": "Adds Sources to flow"
|
||||
},
|
||||
"CreateFlow": {
|
||||
"name": "CreateFlow",
|
||||
|
|
@ -97,7 +139,7 @@
|
|||
"documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
|
||||
}
|
||||
],
|
||||
"documentation": "Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50)."
|
||||
"documentation": "Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50)."
|
||||
},
|
||||
"DeleteFlow": {
|
||||
"name": "DeleteFlow",
|
||||
|
|
@ -369,6 +411,48 @@
|
|||
],
|
||||
"documentation": "Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output."
|
||||
},
|
||||
"RemoveFlowSource": {
|
||||
"name": "RemoveFlowSource",
|
||||
"http": {
|
||||
"method": "DELETE",
|
||||
"requestUri": "/v1/flows/{flowArn}/source/{sourceArn}",
|
||||
"responseCode": 202
|
||||
},
|
||||
"input": {
|
||||
"shape": "RemoveFlowSourceRequest"
|
||||
},
|
||||
"output": {
|
||||
"shape": "RemoveFlowSourceResponse",
|
||||
"documentation": "source successfully removed from flow configuration."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException",
|
||||
"documentation": "The request that you submitted is not valid."
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException",
|
||||
"documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "You don't have the required permissions to perform this operation."
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException",
|
||||
"documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request."
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException",
|
||||
"documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later."
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException",
|
||||
"documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
|
||||
}
|
||||
],
|
||||
"documentation": "Removes a source from an existing flow. This request can be made only if there is more than one source on the flow."
|
||||
},
|
||||
"RevokeFlowEntitlement": {
|
||||
"name": "RevokeFlowEntitlement",
|
||||
"http": {
|
||||
|
|
@ -547,6 +631,48 @@
|
|||
],
|
||||
"documentation": "Deletes specified tags from a resource."
|
||||
},
|
||||
"UpdateFlow": {
|
||||
"name": "UpdateFlow",
|
||||
"http": {
|
||||
"method": "PUT",
|
||||
"requestUri": "/v1/flows/{flowArn}",
|
||||
"responseCode": 202
|
||||
},
|
||||
"input": {
|
||||
"shape": "UpdateFlowRequest"
|
||||
},
|
||||
"output": {
|
||||
"shape": "UpdateFlowResponse",
|
||||
"documentation": "AWS Elemental MediaConnect updated the flow successfully."
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException",
|
||||
"documentation": "The request that you submitted is not valid."
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException",
|
||||
"documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition."
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "You don't have the required permissions to perform this operation."
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException",
|
||||
"documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request."
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException",
|
||||
"documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later."
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException",
|
||||
"documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account."
|
||||
}
|
||||
],
|
||||
"documentation": "Updates flow"
|
||||
},
|
||||
"UpdateFlowEntitlement": {
|
||||
"name": "UpdateFlowEntitlement",
|
||||
"http": {
|
||||
|
|
@ -729,6 +855,42 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"AddFlowSourcesRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FlowArn": {
|
||||
"shape": "__string",
|
||||
"location": "uri",
|
||||
"locationName": "flowArn",
|
||||
"documentation": "The flow that you want to mutate."
|
||||
},
|
||||
"Sources": {
|
||||
"shape": "__listOfSetSourceRequest",
|
||||
"locationName": "sources",
|
||||
"documentation": "A list of sources that you want to add."
|
||||
}
|
||||
},
|
||||
"documentation": "A request to add sources to the flow.",
|
||||
"required": [
|
||||
"FlowArn",
|
||||
"Sources"
|
||||
]
|
||||
},
|
||||
"AddFlowSourcesResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FlowArn": {
|
||||
"shape": "__string",
|
||||
"locationName": "flowArn",
|
||||
"documentation": "The ARN of the flow that these sources were added to."
|
||||
},
|
||||
"Sources": {
|
||||
"shape": "__listOfSource",
|
||||
"locationName": "sources",
|
||||
"documentation": "The details of the newly added sources."
|
||||
}
|
||||
}
|
||||
},
|
||||
"AddOutputRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -863,11 +1025,18 @@
|
|||
"Source": {
|
||||
"shape": "SetSourceRequest",
|
||||
"locationName": "source"
|
||||
},
|
||||
"SourceFailoverConfig": {
|
||||
"shape": "FailoverConfig",
|
||||
"locationName": "sourceFailoverConfig"
|
||||
},
|
||||
"Sources": {
|
||||
"shape": "__listOfSetSourceRequest",
|
||||
"locationName": "sources"
|
||||
}
|
||||
},
|
||||
"documentation": "Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50).",
|
||||
"documentation": "Creates a new flow. The request must include one source. The request optionally can include outputs (up to 50) and entitlements (up to 50).",
|
||||
"required": [
|
||||
"Source",
|
||||
"Name"
|
||||
]
|
||||
},
|
||||
|
|
@ -1032,6 +1201,21 @@
|
|||
"Name"
|
||||
]
|
||||
},
|
||||
"FailoverConfig": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecoveryWindow": {
|
||||
"shape": "__integer",
|
||||
"locationName": "recoveryWindow",
|
||||
"documentation": "Search window time to look for dash-7 packets"
|
||||
},
|
||||
"State": {
|
||||
"shape": "State",
|
||||
"locationName": "state"
|
||||
}
|
||||
},
|
||||
"documentation": "The settings for source failover"
|
||||
},
|
||||
"Flow": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1074,6 +1258,14 @@
|
|||
"shape": "Source",
|
||||
"locationName": "source"
|
||||
},
|
||||
"SourceFailoverConfig": {
|
||||
"shape": "FailoverConfig",
|
||||
"locationName": "sourceFailoverConfig"
|
||||
},
|
||||
"Sources": {
|
||||
"shape": "__listOfSource",
|
||||
"locationName": "sources"
|
||||
},
|
||||
"Status": {
|
||||
"shape": "Status",
|
||||
"locationName": "status",
|
||||
|
|
@ -1522,6 +1714,42 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"RemoveFlowSourceRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FlowArn": {
|
||||
"shape": "__string",
|
||||
"location": "uri",
|
||||
"locationName": "flowArn",
|
||||
"documentation": "The flow that you want to remove a source from."
|
||||
},
|
||||
"SourceArn": {
|
||||
"shape": "__string",
|
||||
"location": "uri",
|
||||
"locationName": "sourceArn",
|
||||
"documentation": "The ARN of the source that you want to remove."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"FlowArn",
|
||||
"SourceArn"
|
||||
]
|
||||
},
|
||||
"RemoveFlowSourceResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FlowArn": {
|
||||
"shape": "__string",
|
||||
"locationName": "flowArn",
|
||||
"documentation": "The ARN of the flow that is associated with the source you removed."
|
||||
},
|
||||
"SourceArn": {
|
||||
"shape": "__string",
|
||||
"locationName": "sourceArn",
|
||||
"documentation": "The ARN of the source that was removed."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ResponseError": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1742,6 +1970,13 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"State": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ENABLED",
|
||||
"DISABLED"
|
||||
]
|
||||
},
|
||||
"Status": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
|
|
@ -1938,6 +2173,21 @@
|
|||
},
|
||||
"documentation": "Information about the encryption of the flow."
|
||||
},
|
||||
"UpdateFailoverConfig": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecoveryWindow": {
|
||||
"shape": "__integer",
|
||||
"locationName": "recoveryWindow",
|
||||
"documentation": "Recovery window time to look for dash-7 packets"
|
||||
},
|
||||
"State": {
|
||||
"shape": "State",
|
||||
"locationName": "state"
|
||||
}
|
||||
},
|
||||
"documentation": "The settings for source failover"
|
||||
},
|
||||
"UpdateFlowEntitlementRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -2075,6 +2325,34 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"UpdateFlowRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"FlowArn": {
|
||||
"shape": "__string",
|
||||
"location": "uri",
|
||||
"locationName": "flowArn",
|
||||
"documentation": "The flow that you want to update."
|
||||
},
|
||||
"SourceFailoverConfig": {
|
||||
"shape": "UpdateFailoverConfig",
|
||||
"locationName": "sourceFailoverConfig"
|
||||
}
|
||||
},
|
||||
"documentation": "A request to update flow.",
|
||||
"required": [
|
||||
"FlowArn"
|
||||
]
|
||||
},
|
||||
"UpdateFlowResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Flow": {
|
||||
"shape": "Flow",
|
||||
"locationName": "flow"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateFlowSourceRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -2202,6 +2480,24 @@
|
|||
"shape": "Output"
|
||||
}
|
||||
},
|
||||
"__listOfSetSourceRequest": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "SetSourceRequest"
|
||||
}
|
||||
},
|
||||
"__listOfSource": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "Source"
|
||||
}
|
||||
},
|
||||
"__listOf__integer": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "__integer"
|
||||
}
|
||||
},
|
||||
"__listOf__string": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
|
|||
|
|
@ -1672,6 +1672,131 @@
|
|||
"USE_CONFIGURED"
|
||||
]
|
||||
},
|
||||
"Av1AdaptiveQuantization": {
|
||||
"type": "string",
|
||||
"documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.",
|
||||
"enum": [
|
||||
"OFF",
|
||||
"LOW",
|
||||
"MEDIUM",
|
||||
"HIGH",
|
||||
"HIGHER",
|
||||
"MAX"
|
||||
]
|
||||
},
|
||||
"Av1FramerateControl": {
|
||||
"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"
|
||||
]
|
||||
},
|
||||
"Av1FramerateConversionAlgorithm": {
|
||||
"type": "string",
|
||||
"documentation": "When set to INTERPOLATE, produces smoother motion during frame rate conversion.",
|
||||
"enum": [
|
||||
"DUPLICATE_DROP",
|
||||
"INTERPOLATE"
|
||||
]
|
||||
},
|
||||
"Av1QvbrSettings": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"QvbrQualityLevel": {
|
||||
"shape": "__integerMin1Max10",
|
||||
"locationName": "qvbrQualityLevel",
|
||||
"documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within av1Settings. Specify the general target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9. Optionally, to specify a value between whole numbers, also provide a value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33."
|
||||
},
|
||||
"QvbrQualityLevelFineTune": {
|
||||
"shape": "__doubleMin0Max1",
|
||||
"locationName": "qvbrQualityLevelFineTune",
|
||||
"documentation": "Optional. Specify a value here to set the QVBR quality to a level that is between whole numbers. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33."
|
||||
}
|
||||
},
|
||||
"documentation": "Settings for quality-defined variable bitrate encoding with the AV1 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode."
|
||||
},
|
||||
"Av1RateControlMode": {
|
||||
"type": "string",
|
||||
"documentation": "'With AV1 outputs, for rate control mode, MediaConvert supports only quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.'",
|
||||
"enum": [
|
||||
"QVBR"
|
||||
]
|
||||
},
|
||||
"Av1Settings": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"AdaptiveQuantization": {
|
||||
"shape": "Av1AdaptiveQuantization",
|
||||
"locationName": "adaptiveQuantization",
|
||||
"documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality."
|
||||
},
|
||||
"FramerateControl": {
|
||||
"shape": "Av1FramerateControl",
|
||||
"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": "Av1FramerateConversionAlgorithm",
|
||||
"locationName": "framerateConversionAlgorithm",
|
||||
"documentation": "When set to INTERPOLATE, produces smoother motion during frame rate conversion."
|
||||
},
|
||||
"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."
|
||||
},
|
||||
"GopSize": {
|
||||
"shape": "__doubleMin0",
|
||||
"locationName": "gopSize",
|
||||
"documentation": "Specify the GOP length (keyframe interval) in frames. With AV1, MediaConvert doesn't support GOP length in seconds. This value must be greater than zero and preferably equal to 1 + ((numberBFrames + 1) * x), where x is an integer value."
|
||||
},
|
||||
"MaxBitrate": {
|
||||
"shape": "__integerMin1000Max1152000000",
|
||||
"locationName": "maxBitrate",
|
||||
"documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR."
|
||||
},
|
||||
"NumberBFramesBetweenReferenceFrames": {
|
||||
"shape": "__integerMin7Max15",
|
||||
"locationName": "numberBFramesBetweenReferenceFrames",
|
||||
"documentation": "Specify the number of B-frames. With AV1, MediaConvert supports only 7 or 15."
|
||||
},
|
||||
"QvbrSettings": {
|
||||
"shape": "Av1QvbrSettings",
|
||||
"locationName": "qvbrSettings",
|
||||
"documentation": "Settings for quality-defined variable bitrate encoding with the AV1 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode."
|
||||
},
|
||||
"RateControlMode": {
|
||||
"shape": "Av1RateControlMode",
|
||||
"locationName": "rateControlMode",
|
||||
"documentation": "'With AV1 outputs, for rate control mode, MediaConvert supports only quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.'"
|
||||
},
|
||||
"Slices": {
|
||||
"shape": "__integerMin1Max32",
|
||||
"locationName": "slices",
|
||||
"documentation": "Specify the number of slices per picture. This value must be 1, 2, 4, 8, 16, or 32. For progressive pictures, this value must be less than or equal to the number of macroblock rows. For interlaced pictures, this value must be less than or equal to half the number of macroblock rows."
|
||||
},
|
||||
"SpatialAdaptiveQuantization": {
|
||||
"shape": "Av1SpatialAdaptiveQuantization",
|
||||
"locationName": "spatialAdaptiveQuantization",
|
||||
"documentation": "Adjust quantization within each frame based on spatial variation of content complexity."
|
||||
}
|
||||
},
|
||||
"documentation": "Required when you set Codec, under VideoDescription>CodecSettings to the value AV1."
|
||||
},
|
||||
"Av1SpatialAdaptiveQuantization": {
|
||||
"type": "string",
|
||||
"documentation": "Adjust quantization within each frame based on spatial variation of content complexity.",
|
||||
"enum": [
|
||||
"DISABLED",
|
||||
"ENABLED"
|
||||
]
|
||||
},
|
||||
"AvailBlanking": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -2387,7 +2512,7 @@
|
|||
"ColorSpaceConversion": {
|
||||
"shape": "ColorSpaceConversion",
|
||||
"locationName": "colorSpaceConversion",
|
||||
"documentation": "Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output."
|
||||
"documentation": "Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, from SDR to HDR, and from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output. HDR to SDR conversion uses Elemental tone mapping technology to approximate the outcome of manually regrading from HDR to SDR."
|
||||
},
|
||||
"Contrast": {
|
||||
"shape": "__integerMin1Max100",
|
||||
|
|
@ -2433,7 +2558,7 @@
|
|||
},
|
||||
"ColorSpaceConversion": {
|
||||
"type": "string",
|
||||
"documentation": "Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output.",
|
||||
"documentation": "Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, from SDR to HDR, and from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output. HDR to SDR conversion uses Elemental tone mapping technology to approximate the outcome of manually regrading from HDR to SDR.",
|
||||
"enum": [
|
||||
"NONE",
|
||||
"FORCE_601",
|
||||
|
|
@ -9094,6 +9219,7 @@
|
|||
"documentation": "Type of video codec",
|
||||
"enum": [
|
||||
"FRAME_CAPTURE",
|
||||
"AV1",
|
||||
"H_264",
|
||||
"H_265",
|
||||
"MPEG2",
|
||||
|
|
@ -9103,6 +9229,11 @@
|
|||
"VideoCodecSettings": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Av1Settings": {
|
||||
"shape": "Av1Settings",
|
||||
"locationName": "av1Settings",
|
||||
"documentation": "Required when you set Codec, under VideoDescription>CodecSettings to the value AV1."
|
||||
},
|
||||
"Codec": {
|
||||
"shape": "VideoCodec",
|
||||
"locationName": "codec",
|
||||
|
|
@ -9134,7 +9265,7 @@
|
|||
"documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES."
|
||||
}
|
||||
},
|
||||
"documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings"
|
||||
"documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * FRAME_CAPTURE, FrameCaptureSettings * AV1, Av1Settings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings"
|
||||
},
|
||||
"VideoDescription": {
|
||||
"type": "structure",
|
||||
|
|
@ -9152,7 +9283,7 @@
|
|||
"CodecSettings": {
|
||||
"shape": "VideoCodecSettings",
|
||||
"locationName": "codecSettings",
|
||||
"documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings"
|
||||
"documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * FRAME_CAPTURE, FrameCaptureSettings * AV1, Av1Settings * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings"
|
||||
},
|
||||
"ColorMetadata": {
|
||||
"shape": "ColorMetadata",
|
||||
|
|
@ -9697,6 +9828,11 @@
|
|||
"min": 64000,
|
||||
"max": 640000
|
||||
},
|
||||
"__integerMin7Max15": {
|
||||
"type": "integer",
|
||||
"min": 7,
|
||||
"max": 15
|
||||
},
|
||||
"__integerMin8000Max192000": {
|
||||
"type": "integer",
|
||||
"min": 8000,
|
||||
|
|
|
|||
|
|
@ -9188,6 +9188,11 @@
|
|||
"MultiplexProgramSettings": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"PreferredChannelPipeline": {
|
||||
"shape": "PreferredChannelPipeline",
|
||||
"locationName": "preferredChannelPipeline",
|
||||
"documentation": "Indicates which pipeline is preferred by the multiplex for program ingest."
|
||||
},
|
||||
"ProgramNumber": {
|
||||
"shape": "__integerMin0Max65535",
|
||||
"locationName": "programNumber",
|
||||
|
|
@ -9772,6 +9777,15 @@
|
|||
"PipelineId"
|
||||
]
|
||||
},
|
||||
"PreferredChannelPipeline": {
|
||||
"type": "string",
|
||||
"documentation": "Indicates which pipeline is preferred by the multiplex for program ingest.\nIf set to \\\"PIPELINE_0\\\" or \\\"PIPELINE_1\\\" and an unhealthy ingest causes the multiplex to switch to the non-preferred pipeline,\nit will switch back once that ingest is healthy again. If set to \\\"CURRENTLY_ACTIVE\\\",\nit will not switch back to the other pipeline based on it recovering to a healthy state,\nit will only switch if the active pipeline becomes unhealthy.\n",
|
||||
"enum": [
|
||||
"CURRENTLY_ACTIVE",
|
||||
"PIPELINE_0",
|
||||
"PIPELINE_1"
|
||||
]
|
||||
},
|
||||
"PurchaseOffering": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
|
|||
|
|
@ -835,6 +835,11 @@
|
|||
"DashManifest": {
|
||||
"documentation": "A DASH manifest configuration.",
|
||||
"members": {
|
||||
"ManifestLayout": {
|
||||
"documentation": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.",
|
||||
"locationName": "manifestLayout",
|
||||
"shape": "ManifestLayout"
|
||||
},
|
||||
"ManifestName": {
|
||||
"documentation": "An optional string to include in the name of the manifest.",
|
||||
"locationName": "manifestName",
|
||||
|
|
@ -869,10 +874,20 @@
|
|||
"locationName": "encryption",
|
||||
"shape": "DashEncryption"
|
||||
},
|
||||
"PeriodTriggers": {
|
||||
"documentation": "A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH)\nMedia Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not\nbe partitioned into more than one period. If the list contains \"ADS\", new periods will be created where\nthe Asset contains SCTE-35 ad markers.\n",
|
||||
"locationName": "periodTriggers",
|
||||
"shape": "__listOf__PeriodTriggersElement"
|
||||
},
|
||||
"SegmentDurationSeconds": {
|
||||
"documentation": "Duration (in seconds) of each segment. Actual segments will be\nrounded to the nearest multiple of the source segment duration.\n",
|
||||
"locationName": "segmentDurationSeconds",
|
||||
"shape": "__integer"
|
||||
},
|
||||
"SegmentTemplateFormat": {
|
||||
"documentation": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.",
|
||||
"locationName": "segmentTemplateFormat",
|
||||
"shape": "SegmentTemplateFormat"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -1322,6 +1337,13 @@
|
|||
},
|
||||
"type": "structure"
|
||||
},
|
||||
"ManifestLayout": {
|
||||
"enum": [
|
||||
"FULL",
|
||||
"COMPACT"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"MaxResults": {
|
||||
"max": 1000,
|
||||
"min": 1,
|
||||
|
|
@ -1539,6 +1561,14 @@
|
|||
],
|
||||
"type": "string"
|
||||
},
|
||||
"SegmentTemplateFormat": {
|
||||
"enum": [
|
||||
"NUMBER_WITH_TIMELINE",
|
||||
"TIME_WITH_TIMELINE",
|
||||
"NUMBER_WITH_DURATION"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"ServiceUnavailableException": {
|
||||
"documentation": "An unexpected error occurred.",
|
||||
"error": {
|
||||
|
|
@ -1636,6 +1666,12 @@
|
|||
},
|
||||
"type": "structure"
|
||||
},
|
||||
"__PeriodTriggersElement": {
|
||||
"enum": [
|
||||
"ADS"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"__boolean": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
|
@ -1687,6 +1723,12 @@
|
|||
},
|
||||
"type": "list"
|
||||
},
|
||||
"__listOf__PeriodTriggersElement": {
|
||||
"member": {
|
||||
"shape": "__PeriodTriggersElement"
|
||||
},
|
||||
"type": "list"
|
||||
},
|
||||
"__listOf__string": {
|
||||
"member": {
|
||||
"shape": "__string"
|
||||
|
|
|
|||
|
|
@ -262,6 +262,10 @@
|
|||
"documentation": "<p>The identifier for the playback configuration.</p>",
|
||||
"shape": "__string"
|
||||
},
|
||||
"PersonalizationThresholdSeconds" : {
|
||||
"documentation": "<p>The maximum duration of underfilled ad time (in seconds) allowed in an ad break.</p>",
|
||||
"shape" : "__integerMin1"
|
||||
},
|
||||
"PlaybackConfigurationArn": {
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. </p>",
|
||||
"shape": "__string"
|
||||
|
|
@ -413,6 +417,10 @@
|
|||
"documentation": "<p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>",
|
||||
"shape": "__string"
|
||||
},
|
||||
"PersonalizationThresholdSeconds" : {
|
||||
"documentation": "<p>The maximum duration of underfilled ad time (in seconds) allowed in an ad break.</p>",
|
||||
"shape" : "__integerMin1"
|
||||
},
|
||||
"VideoContentSourceUrl": {
|
||||
"documentation": "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>",
|
||||
"shape": "__string"
|
||||
|
|
@ -456,6 +464,10 @@
|
|||
"documentation": "<p>The identifier for the playback configuration.</p>",
|
||||
"shape": "__string"
|
||||
},
|
||||
"PersonalizationThresholdSeconds" : {
|
||||
"documentation": "<p>The maximum duration of underfilled ad time (in seconds) allowed in an ad break.</p>",
|
||||
"shape" : "__integerMin1"
|
||||
},
|
||||
"SlateAdUrl": {
|
||||
"documentation": "<p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. </p>",
|
||||
"shape": "__string"
|
||||
|
|
@ -501,6 +513,10 @@
|
|||
"Name": {
|
||||
"documentation": "<p>The identifier for the playback configuration.</p>",
|
||||
"shape": "__string"
|
||||
},
|
||||
"PersonalizationThresholdSeconds" : {
|
||||
"documentation": "<p>The maximum duration of underfilled ad time (in seconds) allowed in an ad break.</p>",
|
||||
"shape" : "__integerMin1"
|
||||
},
|
||||
"PlaybackConfigurationArn": {
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. </p>",
|
||||
|
|
@ -597,6 +613,10 @@
|
|||
},
|
||||
"__integer": {
|
||||
"type": "integer"
|
||||
},
|
||||
"__integerMin1": {
|
||||
"type": "integer",
|
||||
"min": 1
|
||||
},
|
||||
"__integerMin1Max100": {
|
||||
"max": 100,
|
||||
|
|
|
|||
|
|
@ -112,7 +112,7 @@
|
|||
{"shape":"SnapshotQuotaExceededFault"},
|
||||
{"shape":"KMSKeyNotAccessibleFault"}
|
||||
],
|
||||
"documentation":"<p>Copies a snapshot of a DB cluster.</p> <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.</p> <p>You can't copy from one AWS Region to another.</p>"
|
||||
"documentation":"<p>Copies a snapshot of a DB cluster.</p> <p>To copy a DB cluster snapshot from a shared manual DB cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.</p>"
|
||||
},
|
||||
"CopyDBParameterGroup":{
|
||||
"name":"CopyDBParameterGroup",
|
||||
|
|
@ -160,7 +160,7 @@
|
|||
{"shape":"DBInstanceNotFoundFault"},
|
||||
{"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}
|
||||
],
|
||||
"documentation":"<p>Creates a new Amazon Neptune DB cluster.</p> <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.</p>"
|
||||
"documentation":"<p>Creates a new Amazon Neptune DB cluster.</p> <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.</p> <p>Note that when you create a new cluster using <code>CreateDBCluster</code> directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its <code>DeletionProtection</code> field is set to <code>false</code>.</p>"
|
||||
},
|
||||
"CreateDBClusterParameterGroup":{
|
||||
"name":"CreateDBClusterParameterGroup",
|
||||
|
|
@ -309,7 +309,7 @@
|
|||
{"shape":"SnapshotQuotaExceededFault"},
|
||||
{"shape":"InvalidDBClusterSnapshotStateFault"}
|
||||
],
|
||||
"documentation":"<p>The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.</p>"
|
||||
"documentation":"<p>The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.</p> <p>Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its <code>DeletionProtection</code> field to <code>False</code>.</p>"
|
||||
},
|
||||
"DeleteDBClusterParameterGroup":{
|
||||
"name":"DeleteDBClusterParameterGroup",
|
||||
|
|
@ -359,7 +359,7 @@
|
|||
{"shape":"SnapshotQuotaExceededFault"},
|
||||
{"shape":"InvalidDBClusterStateFault"}
|
||||
],
|
||||
"documentation":"<p>The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by <code>DeleteDBInstance</code> are not deleted.</p> <p> If you request a final DB snapshot the status of the Amazon Neptune DB instance is <code>deleting</code> until the DB snapshot is created. The API action <code>DescribeDBInstance</code> is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.</p> <p>Note that when a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>, or <code>incompatible-network</code>, you can only delete it when the <code>SkipFinalSnapshot</code> parameter is set to <code>true</code>.</p> <p>You can't delete a DB instance if it is the only instance in the DB cluster.</p>"
|
||||
"documentation":"<p>The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by <code>DeleteDBInstance</code> are not deleted.</p> <p> If you request a final DB snapshot the status of the Amazon Neptune DB instance is <code>deleting</code> until the DB snapshot is created. The API action <code>DescribeDBInstance</code> is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.</p> <p>Note that when a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>, or <code>incompatible-network</code>, you can only delete it when the <code>SkipFinalSnapshot</code> parameter is set to <code>true</code>.</p> <p>You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.</p>"
|
||||
},
|
||||
"DeleteDBParameterGroup":{
|
||||
"name":"DeleteDBParameterGroup",
|
||||
|
|
@ -483,7 +483,7 @@
|
|||
"errors":[
|
||||
{"shape":"DBClusterNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>Returns information about provisioned DB clusters. This API supports pagination.</p>"
|
||||
"documentation":"<p>Returns information about provisioned DB clusters, and supports pagination.</p> <note> <p>This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.</p> </note>"
|
||||
},
|
||||
"DescribeDBEngineVersions":{
|
||||
"name":"DescribeDBEngineVersions",
|
||||
|
|
@ -512,7 +512,7 @@
|
|||
"errors":[
|
||||
{"shape":"DBInstanceNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>Returns information about provisioned instances. This API supports pagination.</p>"
|
||||
"documentation":"<p>Returns information about provisioned instances, and supports pagination.</p> <note> <p>This operation can also return information for Amazon RDS instances and Amazon DocDB instances.</p> </note>"
|
||||
},
|
||||
"DescribeDBParameterGroups":{
|
||||
"name":"DescribeDBParameterGroups",
|
||||
|
|
@ -1039,6 +1039,42 @@
|
|||
{"shape":"DBClusterParameterGroupNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.</p> <note> <p>This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <a>CreateDBInstance</a> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB cluster is available.</p> </note>"
|
||||
},
|
||||
"StartDBCluster":{
|
||||
"name":"StartDBCluster",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartDBClusterMessage"},
|
||||
"output":{
|
||||
"shape":"StartDBClusterResult",
|
||||
"resultWrapper":"StartDBClusterResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"DBClusterNotFoundFault"},
|
||||
{"shape":"InvalidDBClusterStateFault"},
|
||||
{"shape":"InvalidDBInstanceStateFault"}
|
||||
],
|
||||
"documentation":"<p>Starts an Amazon Neptune DB cluster that was stopped using the AWS console, the AWS CLI stop-db-cluster command, or the StopDBCluster API.</p>"
|
||||
},
|
||||
"StopDBCluster":{
|
||||
"name":"StopDBCluster",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StopDBClusterMessage"},
|
||||
"output":{
|
||||
"shape":"StopDBClusterResult",
|
||||
"resultWrapper":"StopDBClusterResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"DBClusterNotFoundFault"},
|
||||
{"shape":"InvalidDBClusterStateFault"},
|
||||
{"shape":"InvalidDBInstanceStateFault"}
|
||||
],
|
||||
"documentation":"<p>Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.</p> <p>Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -1424,7 +1460,7 @@
|
|||
},
|
||||
"DeletionProtection":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. </p>"
|
||||
"documentation":"<p>A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1672,7 +1708,7 @@
|
|||
},
|
||||
"DeletionProtection":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. </p> <p>You can enable or disable deletion protection for the DB cluster. For more information, see <a>CreateDBCluster</a>. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. </p>"
|
||||
"documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html\">Deleting a DB Instance</a>.</p> <p>DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1938,7 +1974,7 @@
|
|||
},
|
||||
"DeletionProtection":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. </p>"
|
||||
"documentation":"<p>Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the details of an Amazon Neptune DB cluster.</p> <p>This data type is used as a response element in the <a>DescribeDBClusters</a> action.</p>",
|
||||
|
|
@ -2194,7 +2230,7 @@
|
|||
},
|
||||
"DBClusterSnapshotIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specifies the identifier for the DB cluster snapshot.</p>"
|
||||
"documentation":"<p>Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.</p> <p>After you restore a DB cluster using a <code>DBClusterSnapshotIdentifier</code>, you must specify the same <code>DBClusterSnapshotIdentifier</code> for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.</p> <p>However, if you don't specify the <code>DBClusterSnapshotIdentifier</code>, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the <code>DBClusterSnapshotIdentifier</code>, and the original DB cluster is deleted.</p>"
|
||||
},
|
||||
"DBClusterIdentifier":{
|
||||
"shape":"String",
|
||||
|
|
@ -2640,7 +2676,7 @@
|
|||
},
|
||||
"DeletionProtection":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. </p>"
|
||||
"documentation":"<p>Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html\">Deleting a DB Instance</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the details of an Amazon Neptune DB instance.</p> <p>This data type is used as a response element in the <a>DescribeDBInstances</a> action.</p>",
|
||||
|
|
@ -3247,7 +3283,7 @@
|
|||
},
|
||||
"Filters":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p>A filter that specifies one or more DB clusters to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.</p> </li> </ul>"
|
||||
"documentation":"<p>A filter that specifies one or more DB clusters to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>engine</code> - Accepts an engine name (such as <code>neptune</code>), and restricts the results list to DB clusters created by that engine.</p> </li> </ul> <p>For example, to invoke this API from the AWS CLI and filter so that only Neptune DB clusters are returned, you could use the following command:</p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"IntegerOptional",
|
||||
|
|
@ -3309,7 +3345,7 @@
|
|||
},
|
||||
"Filters":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p>A filter that specifies one or more DB instances to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.</p> </li> </ul>"
|
||||
"documentation":"<p>A filter that specifies one or more DB instances to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>engine</code> - Accepts an engine name (such as <code>neptune</code>), and restricts the results list to DB instances created by that engine.</p> </li> </ul> <p>For example, to invoke this API from the AWS CLI and filter so that only Neptune DB instances are returned, you could use the following command:</p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"IntegerOptional",
|
||||
|
|
@ -4204,7 +4240,7 @@
|
|||
},
|
||||
"DeletionProtection":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. </p>"
|
||||
"documentation":"<p>A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4413,7 +4449,7 @@
|
|||
},
|
||||
"DeletionProtection":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. </p>"
|
||||
"documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See <a href=\"https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html\">Deleting a DB Instance</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -5284,6 +5320,38 @@
|
|||
"db-cluster-snapshot"
|
||||
]
|
||||
},
|
||||
"StartDBClusterMessage":{
|
||||
"type":"structure",
|
||||
"required":["DBClusterIdentifier"],
|
||||
"members":{
|
||||
"DBClusterIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The DB cluster identifier of the Neptune DB cluster to be started. This parameter is stored as a lowercase string.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartDBClusterResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DBCluster":{"shape":"DBCluster"}
|
||||
}
|
||||
},
|
||||
"StopDBClusterMessage":{
|
||||
"type":"structure",
|
||||
"required":["DBClusterIdentifier"],
|
||||
"members":{
|
||||
"DBClusterIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The DB cluster identifier of the Neptune DB cluster to be stopped. This parameter is stored as a lowercase string.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StopDBClusterResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DBCluster":{"shape":"DBCluster"}
|
||||
}
|
||||
},
|
||||
"StorageQuotaExceededFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
|
|||
|
|
@ -1286,7 +1286,7 @@
|
|||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\\\\\-@]*)$"
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"TagKeyList":{
|
||||
"type":"list",
|
||||
|
|
@ -1326,7 +1326,7 @@
|
|||
"type":"string",
|
||||
"max":256,
|
||||
"min":0,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\\\\\-@]*)$"
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"TimeWindowDefinition":{
|
||||
"type":"string",
|
||||
|
|
|
|||
|
|
@ -30,6 +30,38 @@
|
|||
],
|
||||
"documentation":"<p>Creates an Outpost.</p>"
|
||||
},
|
||||
"DeleteOutpost":{
|
||||
"name":"DeleteOutpost",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/outposts/{OutpostId}"
|
||||
},
|
||||
"input":{"shape":"DeleteOutpostInput"},
|
||||
"output":{"shape":"DeleteOutpostOutput"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InternalServerException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the Outpost.</p>"
|
||||
},
|
||||
"DeleteSite":{
|
||||
"name":"DeleteSite",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/sites/{SiteId}"
|
||||
},
|
||||
"input":{"shape":"DeleteSiteInput"},
|
||||
"output":{"shape":"DeleteSiteOutput"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InternalServerException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the site.</p>"
|
||||
},
|
||||
"GetOutpost":{
|
||||
"name":"GetOutpost",
|
||||
"http":{
|
||||
|
|
@ -111,14 +143,14 @@
|
|||
},
|
||||
"AvailabilityZone":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The Availability Zone.</p>",
|
||||
"documentation":"<p>The Availability Zone.</p> <p>You must specify <code>AvailabilityZone</code> or <code>AvailabilityZoneId</code>.</p>",
|
||||
"max":1000,
|
||||
"min":1,
|
||||
"pattern":"[a-z\\d-]+"
|
||||
},
|
||||
"AvailabilityZoneId":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The ID of the Availability Zone.</p>",
|
||||
"documentation":"<p>The ID of the Availability Zone.</p> <p>You must specify <code>AvailabilityZone</code> or <code>AvailabilityZoneId</code>.</p>",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"[a-z]+[0-9]+-az[0-9]+"
|
||||
|
|
@ -140,6 +172,38 @@
|
|||
"Outpost":{"shape":"Outpost"}
|
||||
}
|
||||
},
|
||||
"DeleteOutpostInput":{
|
||||
"type":"structure",
|
||||
"required":["OutpostId"],
|
||||
"members":{
|
||||
"OutpostId":{
|
||||
"shape":"OutpostId",
|
||||
"location":"uri",
|
||||
"locationName":"OutpostId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteOutpostOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteSiteInput":{
|
||||
"type":"structure",
|
||||
"required":["SiteId"],
|
||||
"members":{
|
||||
"SiteId":{
|
||||
"shape":"SiteId",
|
||||
"location":"uri",
|
||||
"locationName":"SiteId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteSiteOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"ErrorMessage":{
|
||||
"type":"string",
|
||||
"max":1000,
|
||||
|
|
|
|||
|
|
@ -816,6 +816,10 @@
|
|||
"failureReason":{
|
||||
"shape":"FailureReason",
|
||||
"documentation":"<p>If the batch inference job failed, the reason for the failure.</p>"
|
||||
},
|
||||
"solutionVersionArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The ARN of the solution version used by the batch inference job.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A truncated version of the <a>BatchInferenceJob</a> datatype. The <a>ListBatchInferenceJobs</a> operation returns a list of batch inference job summaries.</p>"
|
||||
|
|
@ -2130,7 +2134,7 @@
|
|||
"members":{
|
||||
"type":{
|
||||
"shape":"HPOObjectiveType",
|
||||
"documentation":"<p>The data type of the metric.</p>"
|
||||
"documentation":"<p>The type of the metric. Valid values are <code>Maximize</code> and <code>Minimize</code>.</p>"
|
||||
},
|
||||
"metricName":{
|
||||
"shape":"MetricName",
|
||||
|
|
@ -2871,6 +2875,10 @@
|
|||
"shape":"TrainingMode",
|
||||
"documentation":"<p>The scope of training used to create the solution version. The <code>FULL</code> option trains the solution version based on the entirety of the input solution's training data, while the <code>UPDATE</code> option processes only the training data that has changed since the creation of the last solution version. Choose <code>UPDATE</code> when you want to start recommending items added to the dataset without retraining the model.</p> <important> <p>The <code>UPDATE</code> option can only be used after you've created a solution version with the <code>FULL</code> option and the training solution uses the <a>native-recipe-hrnn-coldstart</a>.</p> </important>"
|
||||
},
|
||||
"tunedHPOParams":{
|
||||
"shape":"TunedHPOParams",
|
||||
"documentation":"<p>If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.</p>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"Status",
|
||||
"documentation":"<p>The status of the solution version.</p> <p>A solution version can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING</p> </li> <li> <p>CREATE IN_PROGRESS</p> </li> <li> <p>ACTIVE</p> </li> <li> <p>CREATE FAILED</p> </li> </ul>"
|
||||
|
|
@ -2954,6 +2962,16 @@
|
|||
"min":1
|
||||
},
|
||||
"Tunable":{"type":"boolean"},
|
||||
"TunedHPOParams":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"algorithmHyperParameters":{
|
||||
"shape":"HyperParameters",
|
||||
"documentation":"<p>A list of the hyperparameter values of the best performing model.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.</p>"
|
||||
},
|
||||
"UpdateCampaignRequest":{
|
||||
"type":"structure",
|
||||
"required":["campaignArn"],
|
||||
|
|
|
|||
|
|
@ -35,6 +35,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -77,6 +81,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -157,6 +165,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -199,6 +211,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -241,6 +257,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -298,6 +318,52 @@
|
|||
],
|
||||
"documentation": "<p>Creates a message template for messages that are sent through a push notification channel.</p>"
|
||||
},
|
||||
"CreateRecommenderConfiguration": {
|
||||
"name": "CreateRecommenderConfiguration",
|
||||
"http": {
|
||||
"method": "POST",
|
||||
"requestUri": "/v1/recommenders",
|
||||
"responseCode": 201
|
||||
},
|
||||
"input": {
|
||||
"shape": "CreateRecommenderConfigurationRequest"
|
||||
},
|
||||
"output": {
|
||||
"shape": "CreateRecommenderConfigurationResponse",
|
||||
"documentation": "<p>The request succeeded and the specified resource was created.</p>"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException",
|
||||
"documentation": "<p>The request contains a syntax error (BadRequestException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException",
|
||||
"documentation": "<p>The request failed because the specified resource was not found (NotFoundException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "MethodNotAllowedException",
|
||||
"documentation": "<p>The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException",
|
||||
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Creates an Amazon Pinpoint configuration for a recommender model.</p>"
|
||||
},
|
||||
"CreateSegment": {
|
||||
"name": "CreateSegment",
|
||||
"http": {
|
||||
|
|
@ -321,6 +387,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -439,6 +509,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -481,6 +555,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -523,6 +601,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -565,6 +647,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -607,6 +693,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -649,6 +739,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -691,6 +785,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -733,6 +831,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -775,6 +877,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -817,6 +923,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -859,6 +969,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -901,6 +1015,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -943,6 +1061,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -985,6 +1107,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1027,6 +1153,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1046,6 +1176,52 @@
|
|||
],
|
||||
"documentation": "<p>Deletes a message template for messages that were sent through a push notification channel.</p>"
|
||||
},
|
||||
"DeleteRecommenderConfiguration": {
|
||||
"name": "DeleteRecommenderConfiguration",
|
||||
"http": {
|
||||
"method": "DELETE",
|
||||
"requestUri": "/v1/recommenders/{recommender-id}",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "DeleteRecommenderConfigurationRequest"
|
||||
},
|
||||
"output": {
|
||||
"shape": "DeleteRecommenderConfigurationResponse",
|
||||
"documentation": "<p>The request succeeded.</p>"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException",
|
||||
"documentation": "<p>The request contains a syntax error (BadRequestException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException",
|
||||
"documentation": "<p>The request failed because the specified resource was not found (NotFoundException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "MethodNotAllowedException",
|
||||
"documentation": "<p>The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException",
|
||||
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Deletes an Amazon Pinpoint configuration for a recommender model.</p>"
|
||||
},
|
||||
"DeleteSegment": {
|
||||
"name": "DeleteSegment",
|
||||
"http": {
|
||||
|
|
@ -1069,6 +1245,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1111,6 +1291,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1153,6 +1337,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1195,6 +1383,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1237,6 +1429,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1279,6 +1475,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1321,6 +1521,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1363,6 +1567,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1405,6 +1613,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1447,6 +1659,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1489,6 +1705,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1531,6 +1751,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1573,6 +1797,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1615,6 +1843,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1657,6 +1889,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1699,6 +1935,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1741,6 +1981,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1783,6 +2027,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1825,6 +2073,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1867,6 +2119,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1909,6 +2165,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1951,6 +2211,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -1993,6 +2257,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2035,6 +2303,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2077,6 +2349,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2119,6 +2395,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2161,6 +2441,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2203,6 +2487,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2245,6 +2533,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2287,6 +2579,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2329,6 +2625,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2371,6 +2671,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2413,6 +2717,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2455,6 +2763,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2497,6 +2809,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2539,6 +2855,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2581,6 +2901,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2600,6 +2924,98 @@
|
|||
],
|
||||
"documentation": "<p>Retrieves the content and settings of a message template for messages that are sent through a push notification channel.</p>"
|
||||
},
|
||||
"GetRecommenderConfiguration": {
|
||||
"name": "GetRecommenderConfiguration",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"requestUri": "/v1/recommenders/{recommender-id}",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "GetRecommenderConfigurationRequest"
|
||||
},
|
||||
"output": {
|
||||
"shape": "GetRecommenderConfigurationResponse",
|
||||
"documentation": "<p>The request succeeded.</p>"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException",
|
||||
"documentation": "<p>The request contains a syntax error (BadRequestException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException",
|
||||
"documentation": "<p>The request failed because the specified resource was not found (NotFoundException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "MethodNotAllowedException",
|
||||
"documentation": "<p>The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException",
|
||||
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Retrieves information about an Amazon Pinpoint configuration for a recommender model.</p>"
|
||||
},
|
||||
"GetRecommenderConfigurations": {
|
||||
"name": "GetRecommenderConfigurations",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"requestUri": "/v1/recommenders",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "GetRecommenderConfigurationsRequest"
|
||||
},
|
||||
"output": {
|
||||
"shape": "GetRecommenderConfigurationsResponse",
|
||||
"documentation": "<p>The request succeeded.</p>"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException",
|
||||
"documentation": "<p>The request contains a syntax error (BadRequestException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException",
|
||||
"documentation": "<p>The request failed because the specified resource was not found (NotFoundException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "MethodNotAllowedException",
|
||||
"documentation": "<p>The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException",
|
||||
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.</p>"
|
||||
},
|
||||
"GetSegment": {
|
||||
"name": "GetSegment",
|
||||
"http": {
|
||||
|
|
@ -2623,6 +3039,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2665,6 +3085,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2707,6 +3131,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2749,6 +3177,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2791,6 +3223,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2833,6 +3269,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2875,6 +3315,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2917,6 +3361,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -2959,6 +3407,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3001,6 +3453,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3043,6 +3499,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3085,6 +3545,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3119,7 +3583,7 @@
|
|||
"documentation": "<p>The request succeeded.</p>"
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "<p>Retrieves all the tags (keys and values) that are associated with an application, campaign, journey, message template, or segment.</p>"
|
||||
"documentation": "<p>Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.</p>"
|
||||
},
|
||||
"ListTemplateVersions": {
|
||||
"name": "ListTemplateVersions",
|
||||
|
|
@ -3144,6 +3608,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3224,6 +3692,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3266,6 +3738,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3308,6 +3784,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3350,6 +3830,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3392,6 +3876,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3434,6 +3922,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3464,7 +3956,7 @@
|
|||
"shape": "TagResourceRequest"
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "<p>Adds one or more tags (keys and values) to an application, campaign, journey, message template, or segment.</p>"
|
||||
"documentation": "<p>Adds one or more tags (keys and values) to an application, campaign, message template, or segment.</p>"
|
||||
},
|
||||
"UntagResource": {
|
||||
"name": "UntagResource",
|
||||
|
|
@ -3477,7 +3969,7 @@
|
|||
"shape": "UntagResourceRequest"
|
||||
},
|
||||
"errors": [],
|
||||
"documentation": "<p>Removes one or more tags (keys and values) from an application, campaign, journey, message template, or segment.</p>"
|
||||
"documentation": "<p>Removes one or more tags (keys and values) from an application, campaign, message template, or segment.</p>"
|
||||
},
|
||||
"UpdateAdmChannel": {
|
||||
"name": "UpdateAdmChannel",
|
||||
|
|
@ -3502,6 +3994,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3544,6 +4040,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3586,6 +4086,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3628,6 +4132,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3670,6 +4178,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3712,6 +4224,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3754,6 +4270,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3796,6 +4316,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3838,6 +4362,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3880,6 +4408,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3922,6 +4454,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -3964,6 +4500,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -4006,6 +4546,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -4048,6 +4592,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -4090,6 +4638,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -4132,6 +4684,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -4151,6 +4707,52 @@
|
|||
],
|
||||
"documentation": "<p>Updates an existing message template for messages that are sent through a push notification channel.</p>"
|
||||
},
|
||||
"UpdateRecommenderConfiguration": {
|
||||
"name": "UpdateRecommenderConfiguration",
|
||||
"http": {
|
||||
"method": "PUT",
|
||||
"requestUri": "/v1/recommenders/{recommender-id}",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "UpdateRecommenderConfigurationRequest"
|
||||
},
|
||||
"output": {
|
||||
"shape": "UpdateRecommenderConfigurationResponse",
|
||||
"documentation": "<p>The request succeeded.</p>"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException",
|
||||
"documentation": "<p>The request contains a syntax error (BadRequestException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException",
|
||||
"documentation": "<p>The request failed because the specified resource was not found (NotFoundException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "MethodNotAllowedException",
|
||||
"documentation": "<p>The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException",
|
||||
"documentation": "<p>The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).</p>"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Updates an Amazon Pinpoint configuration for a recommender model.</p>"
|
||||
},
|
||||
"UpdateSegment": {
|
||||
"name": "UpdateSegment",
|
||||
"http": {
|
||||
|
|
@ -4174,6 +4776,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -4216,6 +4822,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -4258,6 +4868,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -4300,6 +4914,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -4342,6 +4960,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -4384,6 +5006,10 @@
|
|||
"shape": "InternalServerErrorException",
|
||||
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "PayloadTooLargeException",
|
||||
"documentation": "<p>The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).</p>"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException",
|
||||
"documentation": "<p>The request was denied because access to the specified resource is forbidden (ForbiddenException).</p>"
|
||||
|
|
@ -5173,7 +5799,7 @@
|
|||
},
|
||||
"Context": {
|
||||
"shape": "MapOf__string",
|
||||
"documentation": "<p>An object that maps custom attributes to attributes for the address and is attached to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>"
|
||||
"documentation": "<p>An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive.</p> <p>For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>"
|
||||
},
|
||||
"RawContent": {
|
||||
"shape": "__string",
|
||||
|
|
@ -5227,7 +5853,7 @@
|
|||
},
|
||||
"Url": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.</p>"
|
||||
"documentation": "<p>The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.</p>"
|
||||
|
|
@ -5617,10 +6243,7 @@
|
|||
"documentation": "<p>The subject line, or title, of the email.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies the content and \"From\" address for an email message that's sent to recipients of a campaign.</p>",
|
||||
"required": [
|
||||
"Title"
|
||||
]
|
||||
"documentation": "<p>Specifies the content and \"From\" address for an email message that's sent to recipients of a campaign.</p>"
|
||||
},
|
||||
"CampaignEventFilter": {
|
||||
"type": "structure",
|
||||
|
|
@ -6179,6 +6802,76 @@
|
|||
],
|
||||
"payload": "CreateTemplateMessageBody"
|
||||
},
|
||||
"CreateRecommenderConfiguration": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Attributes": {
|
||||
"shape": "MapOf__string",
|
||||
"documentation": "<p>A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the <b>Attribute finder</b> pane of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:</p> <ul><li><p>An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.</p></li> <li><p>An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p></li></ul> <p>This object is required if the configuration invokes an AWS Lambda function (LambdaFunctionArn) to process recommendation data. Otherwise, don't include this object in your request.</p>"
|
||||
},
|
||||
"Description": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>A custom description of the configuration for the recommender model. The description can contain up to 128 characters.</p>"
|
||||
},
|
||||
"Name": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p>"
|
||||
},
|
||||
"RecommendationProviderIdType": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:</p> <ul><li><p>PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.</p></li> <li><p>PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.</p></li></ul>"
|
||||
},
|
||||
"RecommendationProviderRoleArn": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.</p>"
|
||||
},
|
||||
"RecommendationProviderUri": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.</p>"
|
||||
},
|
||||
"RecommendationTransformerUri": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.</p>"
|
||||
},
|
||||
"RecommendationsDisplayName": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.</p> <p>This name appears in the <b>Attribute finder</b> pane of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.</p>"
|
||||
},
|
||||
"RecommendationsPerMessage": {
|
||||
"shape": "__integer",
|
||||
"documentation": "<p>The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates. The minimum value is 1. The maximum value is 5. The default value is 5.</p> <p>To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.</p>",
|
||||
"required": [
|
||||
"RecommendationProviderUri",
|
||||
"RecommendationProviderRoleArn"
|
||||
]
|
||||
},
|
||||
"CreateRecommenderConfigurationRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"CreateRecommenderConfiguration": {
|
||||
"shape": "CreateRecommenderConfiguration"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"CreateRecommenderConfiguration"
|
||||
],
|
||||
"payload": "CreateRecommenderConfiguration"
|
||||
},
|
||||
"CreateRecommenderConfigurationResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecommenderConfigurationResponse": {
|
||||
"shape": "RecommenderConfigurationResponse"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"RecommenderConfigurationResponse"
|
||||
],
|
||||
"payload": "RecommenderConfigurationResponse"
|
||||
},
|
||||
"CreateSegmentRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -6618,7 +7311,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -6768,7 +7461,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -6787,6 +7480,32 @@
|
|||
],
|
||||
"payload": "MessageBody"
|
||||
},
|
||||
"DeleteRecommenderConfigurationRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecommenderId": {
|
||||
"shape": "__string",
|
||||
"location": "uri",
|
||||
"locationName": "recommender-id",
|
||||
"documentation": "<p>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</p>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"RecommenderId"
|
||||
]
|
||||
},
|
||||
"DeleteRecommenderConfigurationResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecommenderConfigurationResponse": {
|
||||
"shape": "RecommenderConfigurationResponse"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"RecommenderConfigurationResponse"
|
||||
],
|
||||
"payload": "RecommenderConfigurationResponse"
|
||||
},
|
||||
"DeleteSegmentRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -6859,7 +7578,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -6950,7 +7669,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -7189,7 +7908,7 @@
|
|||
},
|
||||
"TemplateVersion": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active</i> version of the template. The <i>active</i> version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</p>"
|
||||
"documentation": "<p>The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.</p>"
|
||||
|
|
@ -7205,6 +7924,10 @@
|
|||
"shape": "__string",
|
||||
"documentation": "<p>The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.</p>"
|
||||
},
|
||||
"RecommenderId": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.</p>"
|
||||
},
|
||||
"Subject": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The subject line, or title, to use in email messages that are based on the message template.</p>"
|
||||
|
|
@ -7248,6 +7971,10 @@
|
|||
"shape": "__string",
|
||||
"documentation": "<p>The date, in ISO 8601 format, when the message template was last modified.</p>"
|
||||
},
|
||||
"RecommenderId": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the recommender model that's used by the message template.</p>"
|
||||
},
|
||||
"Subject": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The subject line, or title, that's used in email messages that are based on the message template.</p>"
|
||||
|
|
@ -7295,7 +8022,7 @@
|
|||
},
|
||||
"Attributes": {
|
||||
"shape": "MapOfListOf__string",
|
||||
"documentation": "<p>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"science\", \"music\", \"travel\"]. You can use these attributes as filter criteria when you create segments.</p> <p>When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.</p>"
|
||||
"documentation": "<p>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.</p> <p>An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.</p>"
|
||||
},
|
||||
"ChannelType": {
|
||||
"shape": "ChannelType",
|
||||
|
|
@ -7335,7 +8062,7 @@
|
|||
},
|
||||
"User": {
|
||||
"shape": "EndpointUser",
|
||||
"documentation": "<p>One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.</p>"
|
||||
"documentation": "<p>One or more custom user attributes that describe the user who's associated with the endpoint.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.</p>"
|
||||
|
|
@ -7444,7 +8171,7 @@
|
|||
},
|
||||
"DeliveryStatus": {
|
||||
"shape": "DeliveryStatus",
|
||||
"documentation": "<p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>"
|
||||
"documentation": "<p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>"
|
||||
},
|
||||
"MessageId": {
|
||||
"shape": "__string",
|
||||
|
|
@ -7478,7 +8205,7 @@
|
|||
},
|
||||
"Attributes": {
|
||||
"shape": "MapOfListOf__string",
|
||||
"documentation": "<p>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"science\", \"music\", \"travel\"]. You can use these attributes as filter criteria when you create segments.</p> <p>When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.</p>"
|
||||
"documentation": "<p>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.</p> <p>An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.</p>"
|
||||
},
|
||||
"ChannelType": {
|
||||
"shape": "ChannelType",
|
||||
|
|
@ -7532,7 +8259,7 @@
|
|||
},
|
||||
"Attributes": {
|
||||
"shape": "MapOfListOf__string",
|
||||
"documentation": "<p>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"science\", \"music\", \"travel\"]. You can use these attributes as filter criteria when you create segments.</p>"
|
||||
"documentation": "<p>One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments.</p>"
|
||||
},
|
||||
"ChannelType": {
|
||||
"shape": "ChannelType",
|
||||
|
|
@ -7594,7 +8321,7 @@
|
|||
},
|
||||
"Context": {
|
||||
"shape": "MapOf__string",
|
||||
"documentation": "<p>A map of custom attributes to attach to the message for the address. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>"
|
||||
"documentation": "<p>A map of custom attributes to attach to the message for the address. Attribute names are case sensitive.</p> <p>For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.</p>"
|
||||
},
|
||||
"RawContent": {
|
||||
"shape": "__string",
|
||||
|
|
@ -7616,7 +8343,7 @@
|
|||
"members": {
|
||||
"UserAttributes": {
|
||||
"shape": "MapOfListOf__string",
|
||||
"documentation": "<p>One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: [\"science\", \"music\", \"travel\"]. You can use these attributes as filter criteria when you create segments.</p> <p>When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.</p>"
|
||||
"documentation": "<p>One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: [\"Science\", \"Music\", \"Travel\"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.</p> <p>An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.</p>"
|
||||
},
|
||||
"UserId": {
|
||||
"shape": "__string",
|
||||
|
|
@ -7714,7 +8441,7 @@
|
|||
},
|
||||
"EventType": {
|
||||
"shape": "SetDimension",
|
||||
"documentation": "<p>The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.</p>"
|
||||
"documentation": "<p>The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see <a href=\"https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html\">Streaming Amazon Pinpoint Events</a> in the <i>Amazon Pinpoint Developer Guide</i>.</p>"
|
||||
},
|
||||
"Metrics": {
|
||||
"shape": "MapOfMetricDimension",
|
||||
|
|
@ -8795,7 +9522,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -9054,7 +9781,7 @@
|
|||
"shape": "__timestampIso8601",
|
||||
"location": "querystring",
|
||||
"locationName": "end-time",
|
||||
"documentation": "<p>The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.</p>"
|
||||
"documentation": "<p>The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.</p>"
|
||||
},
|
||||
"JourneyId": {
|
||||
"shape": "__string",
|
||||
|
|
@ -9084,7 +9811,7 @@
|
|||
"shape": "__timestampIso8601",
|
||||
"location": "querystring",
|
||||
"locationName": "start-time",
|
||||
"documentation": "<p>The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.</p>"
|
||||
"documentation": "<p>The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.</p>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -9248,7 +9975,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -9267,6 +9994,61 @@
|
|||
],
|
||||
"payload": "PushNotificationTemplateResponse"
|
||||
},
|
||||
"GetRecommenderConfigurationRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecommenderId": {
|
||||
"shape": "__string",
|
||||
"location": "uri",
|
||||
"locationName": "recommender-id",
|
||||
"documentation": "<p>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</p>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"RecommenderId"
|
||||
]
|
||||
},
|
||||
"GetRecommenderConfigurationResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecommenderConfigurationResponse": {
|
||||
"shape": "RecommenderConfigurationResponse"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"RecommenderConfigurationResponse"
|
||||
],
|
||||
"payload": "RecommenderConfigurationResponse"
|
||||
},
|
||||
"GetRecommenderConfigurationsRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"PageSize": {
|
||||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "page-size",
|
||||
"documentation": "<p>The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.</p>"
|
||||
},
|
||||
"Token": {
|
||||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "token",
|
||||
"documentation": "<p>The NextToken string that specifies which page of results to return in a paginated response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetRecommenderConfigurationsResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"ListRecommenderConfigurationsResponse": {
|
||||
"shape": "ListRecommenderConfigurationsResponse"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"ListRecommenderConfigurationsResponse"
|
||||
],
|
||||
"payload": "ListRecommenderConfigurationsResponse"
|
||||
},
|
||||
"GetSegmentExportJobsRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -9552,7 +10334,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -9643,7 +10425,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -9712,7 +10494,7 @@
|
|||
},
|
||||
"SegmentName": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.</p>"
|
||||
"documentation": "<p>A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.</p>",
|
||||
|
|
@ -10100,7 +10882,7 @@
|
|||
"tags": {
|
||||
"shape": "MapOf__string",
|
||||
"locationName": "tags",
|
||||
"documentation": "<p>A string-to-string map of key-value pairs that identifies the tags that are associated with the journey. Each tag consists of a required tag key and an associated tag value.</p>"
|
||||
"documentation": "<p>This object is not used or supported.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Provides information about the status, configuration, and other settings for a journey.</p>",
|
||||
|
|
@ -10193,6 +10975,23 @@
|
|||
],
|
||||
"payload": "JourneysResponse"
|
||||
},
|
||||
"ListRecommenderConfigurationsResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Item": {
|
||||
"shape": "ListOfRecommenderConfigurationResponse",
|
||||
"documentation": "<p>An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.</p>"
|
||||
},
|
||||
"NextToken": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Provides information about all the recommender model configurations that are associated with your Amazon Pinpoint account.</p>",
|
||||
"required": [
|
||||
"Item"
|
||||
]
|
||||
},
|
||||
"ListTagsForResourceRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -10470,7 +11269,7 @@
|
|||
"members": {
|
||||
"DeliveryStatus": {
|
||||
"shape": "DeliveryStatus",
|
||||
"documentation": "<p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>"
|
||||
"documentation": "<p>The delivery status of the message. Possible values are:</p> <ul> <li><p>DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>SUCCESSFUL - The message was successfully delivered to the endpoint address.</p></li> <li><p>TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again.</p></li> <li><p>THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.</p></li> <li><p>TIMEOUT - The message couldn't be sent within the timeout period.</p></li> <li><p>UNKNOWN_FAILURE - An unknown error occurred.</p></li></ul>"
|
||||
},
|
||||
"MessageId": {
|
||||
"shape": "__string",
|
||||
|
|
@ -10678,6 +11477,24 @@
|
|||
"ANY"
|
||||
]
|
||||
},
|
||||
"PayloadTooLargeException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Message": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The message that's returned from the API.</p>"
|
||||
},
|
||||
"RequestID": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the request or response.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Provides information about an API request or response.</p>",
|
||||
"exception": true,
|
||||
"error": {
|
||||
"httpStatusCode": 413
|
||||
}
|
||||
},
|
||||
"PhoneNumberValidateRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -10779,6 +11596,10 @@
|
|||
"shape": "AndroidPushNotificationTemplate",
|
||||
"documentation": "<p>The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).</p>"
|
||||
},
|
||||
"RecommenderId": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "MapOf__string",
|
||||
"locationName": "tags",
|
||||
|
|
@ -10830,6 +11651,10 @@
|
|||
"shape": "__string",
|
||||
"documentation": "<p>The date, in ISO 8601 format, when the message template was last modified.</p>"
|
||||
},
|
||||
"RecommenderId": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the recommender model that's used by the message template.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "MapOf__string",
|
||||
"locationName": "tags",
|
||||
|
|
@ -10998,6 +11823,67 @@
|
|||
"INACTIVE"
|
||||
]
|
||||
},
|
||||
"RecommenderConfigurationResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Attributes": {
|
||||
"shape": "MapOf__string",
|
||||
"documentation": "<p>A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>This value is null if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.</p>"
|
||||
},
|
||||
"CreationDate": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The date, in extended ISO 8601 format, when the configuration was created for the recommender model.</p>"
|
||||
},
|
||||
"Description": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The custom description of the configuration for the recommender model.</p>"
|
||||
},
|
||||
"Id": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the recommender model configuration.</p>"
|
||||
},
|
||||
"LastModifiedDate": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.</p>"
|
||||
},
|
||||
"Name": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The custom name of the configuration for the recommender model.</p>"
|
||||
},
|
||||
"RecommendationProviderIdType": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are:</p> <ul><li><p>PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.</p></li> <li><p>PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.</p></li></ul>"
|
||||
},
|
||||
"RecommendationProviderRoleArn": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.</p>"
|
||||
},
|
||||
"RecommendationProviderUri": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.</p>"
|
||||
},
|
||||
"RecommendationTransformerUri": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.</p>"
|
||||
},
|
||||
"RecommendationsDisplayName": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This name appears in the <b>Attribute finder</b> pane of the template editor on the Amazon Pinpoint console.</p> <p>This value is null if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.</p>"
|
||||
},
|
||||
"RecommendationsPerMessage": {
|
||||
"shape": "__integer",
|
||||
"documentation": "<p>The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Provides information about Amazon Pinpoint configuration settings for retrieving and processing data from a recommender model.</p>",
|
||||
"required": [
|
||||
"RecommendationProviderUri",
|
||||
"LastModifiedDate",
|
||||
"CreationDate",
|
||||
"RecommendationProviderRoleArn",
|
||||
"Id"
|
||||
]
|
||||
},
|
||||
"RemoveAttributesRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -11201,6 +12087,10 @@
|
|||
"shape": "__string",
|
||||
"documentation": "<p>A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.</p>"
|
||||
},
|
||||
"RecommenderId": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "MapOf__string",
|
||||
"locationName": "tags",
|
||||
|
|
@ -11236,6 +12126,10 @@
|
|||
"shape": "__string",
|
||||
"documentation": "<p>The date, in ISO 8601 format, when the message template was last modified.</p>"
|
||||
},
|
||||
"RecommenderId": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the recommender model that's used by the message template.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "MapOf__string",
|
||||
"locationName": "tags",
|
||||
|
|
@ -11291,7 +12185,7 @@
|
|||
},
|
||||
"StartTime": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The scheduled time, in ISO 8601 format, when the campaign began or will begin.</p>"
|
||||
"documentation": "<p>The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.</p>"
|
||||
},
|
||||
"Timezone": {
|
||||
"shape": "__string",
|
||||
|
|
@ -11840,10 +12734,10 @@
|
|||
"tags": {
|
||||
"shape": "MapOf__string",
|
||||
"locationName": "tags",
|
||||
"documentation": "<p>A string-to-string map of key-value pairs that defines the tags for an application, campaign, journey, message template, or segment. Each of these resources can have a maximum of 50 tags.</p> <p>Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>"
|
||||
"documentation": "<p>A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.</p> <p>Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies the tags (keys and values) for an application, campaign, journey, message template, or segment.</p>",
|
||||
"documentation": "<p>Specifies the tags (keys and values) for an application, campaign, message template, or segment.</p>",
|
||||
"required": [
|
||||
"tags"
|
||||
]
|
||||
|
|
@ -11857,7 +12751,7 @@
|
|||
},
|
||||
"Version": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active</i> version of the template. The <i>active</i> version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</p>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If you don't specify a value for this property, Amazon Pinpoint uses the <i>active version</i> of the template. The <i>active version</i> is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies the name and version of the message template to use for the message.</p>"
|
||||
|
|
@ -11867,7 +12761,7 @@
|
|||
"members": {
|
||||
"Version": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to use as the active version of the template. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p>"
|
||||
"documentation": "<p>The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies which version of a message template to use as the active version of the template.</p>"
|
||||
|
|
@ -11889,7 +12783,7 @@
|
|||
},
|
||||
"VoiceTemplate": {
|
||||
"shape": "Template",
|
||||
"documentation": "<p>The voice template to use for the message.</p>"
|
||||
"documentation": "<p>The voice template to use for the message. This object isn't supported for campaigns.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies the message template to use for the message, for each type of channel.</p>"
|
||||
|
|
@ -11899,7 +12793,7 @@
|
|||
"members": {
|
||||
"Arn": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) of the message template.</p>"
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.</p>"
|
||||
},
|
||||
"CreationDate": {
|
||||
"shape": "__string",
|
||||
|
|
@ -11907,7 +12801,7 @@
|
|||
},
|
||||
"DefaultSubstitutions": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.</p>"
|
||||
"documentation": "<p>The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.</p>"
|
||||
},
|
||||
"LastModifiedDate": {
|
||||
"shape": "__string",
|
||||
|
|
@ -11916,11 +12810,11 @@
|
|||
"tags": {
|
||||
"shape": "MapOf__string",
|
||||
"locationName": "tags",
|
||||
"documentation": "<p>A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.</p>"
|
||||
"documentation": "<p>A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.</p>"
|
||||
},
|
||||
"TemplateDescription": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The custom description of the message template.</p>"
|
||||
"documentation": "<p>The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.</p>"
|
||||
},
|
||||
"TemplateName": {
|
||||
"shape": "__string",
|
||||
|
|
@ -12426,7 +13320,7 @@
|
|||
"shape": "__boolean",
|
||||
"location": "querystring",
|
||||
"locationName": "create-new-version",
|
||||
"documentation": "<p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to the latest existing version of the template.</p><p> If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>"
|
||||
"documentation": "<p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>"
|
||||
},
|
||||
"EmailTemplateRequest": {
|
||||
"shape": "EmailTemplateRequest"
|
||||
|
|
@ -12441,7 +13335,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -12645,7 +13539,7 @@
|
|||
"shape": "__boolean",
|
||||
"location": "querystring",
|
||||
"locationName": "create-new-version",
|
||||
"documentation": "<p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to the latest existing version of the template.</p><p> If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>"
|
||||
"documentation": "<p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>"
|
||||
},
|
||||
"PushNotificationTemplateRequest": {
|
||||
"shape": "PushNotificationTemplateRequest"
|
||||
|
|
@ -12660,7 +13554,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -12681,6 +13575,83 @@
|
|||
],
|
||||
"payload": "MessageBody"
|
||||
},
|
||||
"UpdateRecommenderConfiguration": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"Attributes": {
|
||||
"shape": "MapOf__string",
|
||||
"documentation": "<p>A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommenderUserIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template.</p> <p>In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the <b>Attribute finder</b> pane of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names:</p> <ul><li><p>An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique.</p></li> <li><p>An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p></li></ul> <p>This object is required if the configuration invokes an AWS Lambda function (LambdaFunctionArn) to process recommendation data. Otherwise, don't include this object in your request.</p>"
|
||||
},
|
||||
"Description": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>A custom description of the configuration for the recommender model. The description can contain up to 128 characters.</p>"
|
||||
},
|
||||
"Name": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).</p>"
|
||||
},
|
||||
"RecommendationProviderIdType": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are:</p> <ul><li><p>PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value.</p></li> <li><p>PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify a both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.</p></li></ul>"
|
||||
},
|
||||
"RecommendationProviderRoleArn": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.</p>"
|
||||
},
|
||||
"RecommendationProviderUri": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.</p>"
|
||||
},
|
||||
"RecommendationTransformerUri": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.</p>"
|
||||
},
|
||||
"RecommendationsDisplayName": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores a recommended item for each endpoint or user, depending on the value for the RecommenderUserIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.</p> <p>This name appears in the <b>Attribute finder</b> pane of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.</p>"
|
||||
},
|
||||
"RecommendationsPerMessage": {
|
||||
"shape": "__integer",
|
||||
"documentation": "<p>The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommenderUserIdType property. This number determines how many recommended attributes are available for use as message variables in message templates. The minimum value is 1. The maximum value is 5. The default value is 5.</p> <p>To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (LambdaFunctionArn) to perform additional processing of recommendation data.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies Amazon Pinpoint configuration settings for retrieving and processing recommendation data from a recommender model.</p>",
|
||||
"required": [
|
||||
"RecommendationProviderUri",
|
||||
"RecommendationProviderRoleArn"
|
||||
]
|
||||
},
|
||||
"UpdateRecommenderConfigurationRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecommenderId": {
|
||||
"shape": "__string",
|
||||
"location": "uri",
|
||||
"locationName": "recommender-id",
|
||||
"documentation": "<p>The unique identifier for the recommender model configuration. This identifier is displayed as the <b>Recommender ID</b> on the Amazon Pinpoint console.</p>"
|
||||
},
|
||||
"UpdateRecommenderConfiguration": {
|
||||
"shape": "UpdateRecommenderConfiguration"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"RecommenderId",
|
||||
"UpdateRecommenderConfiguration"
|
||||
],
|
||||
"payload": "UpdateRecommenderConfiguration"
|
||||
},
|
||||
"UpdateRecommenderConfigurationResponse": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"RecommenderConfigurationResponse": {
|
||||
"shape": "RecommenderConfigurationResponse"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"RecommenderConfigurationResponse"
|
||||
],
|
||||
"payload": "RecommenderConfigurationResponse"
|
||||
},
|
||||
"UpdateSegmentRequest": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -12757,7 +13728,7 @@
|
|||
"shape": "__boolean",
|
||||
"location": "querystring",
|
||||
"locationName": "create-new-version",
|
||||
"documentation": "<p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to the latest existing version of the template.</p><p> If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>"
|
||||
"documentation": "<p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>"
|
||||
},
|
||||
"SMSTemplateRequest": {
|
||||
"shape": "SMSTemplateRequest"
|
||||
|
|
@ -12772,7 +13743,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
|
|
@ -12869,7 +13840,7 @@
|
|||
"shape": "__boolean",
|
||||
"location": "querystring",
|
||||
"locationName": "create-new-version",
|
||||
"documentation": "<p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to the latest existing version of the template.</p><p> If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>"
|
||||
"documentation": "<p>Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.</p>"
|
||||
},
|
||||
"TemplateName": {
|
||||
"shape": "__string",
|
||||
|
|
@ -12881,7 +13852,7 @@
|
|||
"shape": "__string",
|
||||
"location": "querystring",
|
||||
"locationName": "version",
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier of an existing template version. If specified for an update operation, this value must match the identifier of the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
"documentation": "<p>The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the <link linkend=\"templates-template-name-template-type-versions\">Template Versions</link> resource.</p> <p>If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur.</p> <p>If you don't specify a value for this parameter, Amazon Pinpoint does the following:</p> <ul><li><p>For a get operation, retrieves information about the active version of the template.</p></li> <li><p>For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false.</p></li> <li><p>For a delete operation, deletes the template, including all versions of the template.</p></li></ul>"
|
||||
},
|
||||
"VoiceTemplateRequest": {
|
||||
"shape": "VoiceTemplateRequest"
|
||||
|
|
@ -13165,7 +14136,7 @@
|
|||
},
|
||||
"Name": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The custom name of the campaign.</p>"
|
||||
"documentation": "<p>A custom name for the campaign.</p>"
|
||||
},
|
||||
"Schedule": {
|
||||
"shape": "Schedule",
|
||||
|
|
@ -13194,7 +14165,7 @@
|
|||
},
|
||||
"TreatmentName": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The custom name of a variation of the campaign to use for A/B testing.</p>"
|
||||
"documentation": "<p>A custom name for a variation of the campaign to use for A/B testing.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies the configuration and other settings for a campaign.</p>"
|
||||
|
|
@ -13222,7 +14193,7 @@
|
|||
"members": {
|
||||
"Activities": {
|
||||
"shape": "MapOfActivity",
|
||||
"documentation": "<p>A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.</p>"
|
||||
"documentation": "<p>A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.</p>"
|
||||
},
|
||||
"CreationDate": {
|
||||
"shape": "__string",
|
||||
|
|
@ -13258,7 +14229,7 @@
|
|||
},
|
||||
"StartActivity": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The unique identifier for the first activity in the journey. An activity identifier can contain a maximum of 128 characters. The characters must be alphanumeric characters.</p>"
|
||||
"documentation": "<p>The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.</p>"
|
||||
},
|
||||
"StartCondition": {
|
||||
"shape": "StartCondition",
|
||||
|
|
@ -13322,7 +14293,7 @@
|
|||
},
|
||||
"TreatmentName": {
|
||||
"shape": "__string",
|
||||
"documentation": "<p>The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.</p>"
|
||||
"documentation": "<p>A custom name for the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.</p>",
|
||||
|
|
@ -13399,6 +14370,12 @@
|
|||
"shape": "RandomSplitEntry"
|
||||
}
|
||||
},
|
||||
"ListOfRecommenderConfigurationResponse": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "RecommenderConfigurationResponse"
|
||||
}
|
||||
},
|
||||
"ListOfResultRow": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
|
|||
|
|
@ -930,6 +930,24 @@
|
|||
],
|
||||
"documentation":"<p>Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request. </p>"
|
||||
},
|
||||
"SearchDashboards":{
|
||||
"name":"SearchDashboards",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/accounts/{AwsAccountId}/search/dashboards"
|
||||
},
|
||||
"input":{"shape":"SearchDashboardsRequest"},
|
||||
"output":{"shape":"SearchDashboardsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Searchs for dashboards that belong to a user. </p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
"http":{
|
||||
|
|
@ -2337,6 +2355,10 @@
|
|||
"COLUMN_REPLACEMENT_MISSING"
|
||||
]
|
||||
},
|
||||
"DashboardFilterAttribute":{
|
||||
"type":"string",
|
||||
"enum":["QUICKSIGHT_USER"]
|
||||
},
|
||||
"DashboardName":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
|
|
@ -2361,6 +2383,30 @@
|
|||
},
|
||||
"documentation":"<p>Dashboard publish options.</p>"
|
||||
},
|
||||
"DashboardSearchFilter":{
|
||||
"type":"structure",
|
||||
"required":["Operator"],
|
||||
"members":{
|
||||
"Operator":{
|
||||
"shape":"FilterOperator",
|
||||
"documentation":"<p>The comparison operator that you want to use as a filter. For example, <code>\"Operator\": \"StringEquals\"</code>.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"DashboardFilterAttribute",
|
||||
"documentation":"<p>The name of the value that you want to use as a filter. For example, <code>\"Name\": \"QUICKSIGHT_USER\"</code>. </p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The value of the named item, in this case <code>QUICKSIGHT_USER</code>, that you want to use as a filter. For example, <code>\"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A filter that you apply when searching for dashboards. </p>"
|
||||
},
|
||||
"DashboardSearchFilterList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DashboardSearchFilter"},
|
||||
"max":1
|
||||
},
|
||||
"DashboardSourceEntity":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -4064,6 +4110,10 @@
|
|||
},
|
||||
"documentation":"<p>A transform operation that filters rows based on a condition.</p>"
|
||||
},
|
||||
"FilterOperator":{
|
||||
"type":"string",
|
||||
"enum":["StringEquals"]
|
||||
},
|
||||
"GeoSpatialColumnGroup":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -6137,6 +6187,55 @@
|
|||
},
|
||||
"documentation":"<p>A physical table type for as S3 data source.</p>"
|
||||
},
|
||||
"SearchDashboardsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"Filters"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the user whose dashboards you're searching for. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"Filters":{
|
||||
"shape":"DashboardSearchFilterList",
|
||||
"documentation":"<p>The filters to apply to the search. Currently, you can search only by user name. For example, <code>\"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]</code> </p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results to be returned per request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SearchDashboardsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DashboardSummaryList":{
|
||||
"shape":"DashboardSummaryList",
|
||||
"documentation":"<p>The list of dashboards owned by the user specified in <code>Filters</code> in your request.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ServiceNowParameters":{
|
||||
"type":"structure",
|
||||
"required":["SiteBaseUrl"],
|
||||
|
|
|
|||
|
|
@ -840,7 +840,8 @@
|
|||
"errors":[
|
||||
{"shape":"DBProxyTargetNotFoundFault"},
|
||||
{"shape":"DBProxyTargetGroupNotFoundFault"},
|
||||
{"shape":"DBProxyNotFoundFault"}
|
||||
{"shape":"DBProxyNotFoundFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Remove the association between one or more <code>DBProxyTarget</code> data structures and a <code>DBProxyTargetGroup</code>.</p>"
|
||||
},
|
||||
|
|
@ -1123,7 +1124,9 @@
|
|||
"resultWrapper":"DescribeDBProxyTargetGroupsResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"DBProxyTargetGroupNotFoundFault"}
|
||||
{"shape":"DBProxyNotFoundFault"},
|
||||
{"shape":"DBProxyTargetGroupNotFoundFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Returns information about DB proxy target groups, represented by <code>DBProxyTargetGroup</code> data structures.</p>"
|
||||
},
|
||||
|
|
@ -1141,7 +1144,8 @@
|
|||
"errors":[
|
||||
{"shape":"DBProxyNotFoundFault"},
|
||||
{"shape":"DBProxyTargetNotFoundFault"},
|
||||
{"shape":"DBProxyTargetGroupNotFoundFault"}
|
||||
{"shape":"DBProxyTargetGroupNotFoundFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Returns information about <code>DBProxyTarget</code> objects. This API supports pagination.</p>"
|
||||
},
|
||||
|
|
@ -1711,7 +1715,8 @@
|
|||
},
|
||||
"errors":[
|
||||
{"shape":"DBProxyNotFoundFault"},
|
||||
{"shape":"DBProxyTargetGroupNotFoundFault"}
|
||||
{"shape":"DBProxyTargetGroupNotFoundFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Modifies the properties of a <code>DBProxyTargetGroup</code>.</p>"
|
||||
},
|
||||
|
|
@ -1911,7 +1916,8 @@
|
|||
{"shape":"DBInstanceNotFoundFault"},
|
||||
{"shape":"DBProxyTargetAlreadyRegisteredFault"},
|
||||
{"shape":"InvalidDBInstanceStateFault"},
|
||||
{"shape":"InvalidDBClusterStateFault"}
|
||||
{"shape":"InvalidDBClusterStateFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Associate one or more <code>DBProxyTarget</code> data structures with a <code>DBProxyTargetGroup</code>.</p>"
|
||||
},
|
||||
|
|
@ -2087,7 +2093,7 @@
|
|||
{"shape":"DomainNotFoundFault"},
|
||||
{"shape":"DBClusterParameterGroupNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot. This action only applies to Aurora DB clusters.</p> <p>The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.</p> <note> <p>This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <code>CreateDBInstance</code> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterFromSnapshot</code> action has completed and the DB cluster is available.</p> </note> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p>"
|
||||
"documentation":"<p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot.</p> <p>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.</p> <p>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster. If you don't specify a security group, the new DB cluster is associated with the default security group.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
|
||||
},
|
||||
"RestoreDBClusterToPointInTime":{
|
||||
"name":"RestoreDBClusterToPointInTime",
|
||||
|
|
@ -3255,6 +3261,14 @@
|
|||
"CopyTagsToSnapshot":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.</p>"
|
||||
},
|
||||
"Domain":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Active Directory directory ID to create the DB cluster in.</p> <p> For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurmysql-kerberos.html\">Using Kerberos Authentication for Aurora MySQL</a> in the <i>Amazon Aurora User Guide</i>. </p>"
|
||||
},
|
||||
"DomainIAMRoleName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -4239,6 +4253,10 @@
|
|||
"CrossAccountClone":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.</p>"
|
||||
},
|
||||
"DomainMemberships":{
|
||||
"shape":"DomainMembershipList",
|
||||
"documentation":"<p>The Active Directory Domain membership records associated with the DB cluster.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the details of an Amazon Aurora DB cluster. </p> <p>This data type is used as a response element in the <code>DescribeDBClusters</code>, <code>StopDBCluster</code>, and <code>StartDBCluster</code> actions. </p>",
|
||||
|
|
@ -5661,7 +5679,7 @@
|
|||
},
|
||||
"documentation":"<p>The specified proxy name must be unique for all proxies owned by your AWS account in the specified AWS Region.</p>",
|
||||
"error":{
|
||||
"code":"DBProxyAlreadyExistsFault",
|
||||
"code":"DBProxyTargetExistsFault",
|
||||
"httpStatusCode":400,
|
||||
"senderFault":true
|
||||
},
|
||||
|
|
@ -7371,7 +7389,7 @@
|
|||
"documentation":"<p> An optional pagination token provided by a previous <code>DescribeExportTasks</code> request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter. </p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"String",
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later <code>DescribeExportTasks</code> request to retrieve the remaining results. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -7676,7 +7694,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).</p>"
|
||||
"documentation":"<p>The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.</p>"
|
||||
},
|
||||
"FQDN":{
|
||||
"shape":"String",
|
||||
|
|
@ -7687,7 +7705,7 @@
|
|||
"documentation":"<p>The name of the IAM role to be used when making API calls to the Directory Service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An Active Directory Domain membership record associated with the DB instance.</p>"
|
||||
"documentation":"<p>An Active Directory Domain membership record associated with the DB instance or cluster.</p>"
|
||||
},
|
||||
"DomainMembershipList":{
|
||||
"type":"list",
|
||||
|
|
@ -7695,7 +7713,7 @@
|
|||
"shape":"DomainMembership",
|
||||
"locationName":"DomainMembership"
|
||||
},
|
||||
"documentation":"<p>List of Active Directory Domain membership records associated with a DB instance.</p>"
|
||||
"documentation":"<p>List of Active Directory Domain membership records associated with a DB instance or cluster.</p>"
|
||||
},
|
||||
"DomainNotFoundFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -9016,6 +9034,14 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>The name of the DB parameter group to apply to all instances of the DB cluster. </p> <note> <p>When you apply a parameter group using the <code>DBInstanceParameterGroupName</code> parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.</p> </note> <p>Default: The existing name setting</p> <p>Constraints:</p> <ul> <li> <p>The DB parameter group must be in the same DB parameter group family as this DB cluster.</p> </li> <li> <p>The <code>DBInstanceParameterGroupName</code> parameter is only valid in combination with the <code>AllowMajorVersionUpgrade</code> parameter.</p> </li> </ul>"
|
||||
},
|
||||
"Domain":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Active Directory directory ID to move the DB cluster to. Specify <code>none</code> to remove the cluster from its current domain. The domain must be created prior to this operation. </p>"
|
||||
},
|
||||
"DomainIAMRoleName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>"
|
||||
},
|
||||
"ScalingConfiguration":{
|
||||
"shape":"ScalingConfiguration",
|
||||
"documentation":"<p>The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in <code>serverless</code> DB engine mode.</p>"
|
||||
|
|
@ -11028,6 +11054,14 @@
|
|||
"CopyTagsToSnapshot":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p>"
|
||||
},
|
||||
"Domain":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. </p> <p> For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurmysql-kerberos.html\">Using Kerberos Authentication for Aurora MySQL</a> in the <i>Amazon Aurora User Guide</i>. </p>"
|
||||
},
|
||||
"DomainIAMRoleName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -11124,6 +11158,14 @@
|
|||
"CopyTagsToSnapshot":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p>"
|
||||
},
|
||||
"Domain":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. </p>"
|
||||
},
|
||||
"DomainIAMRoleName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -11205,6 +11247,14 @@
|
|||
"CopyTagsToSnapshot":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.</p>"
|
||||
},
|
||||
"Domain":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. </p> <p> For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurmysql-kerberos.html\">Using Kerberos Authentication for Aurora MySQL</a> in the <i>Amazon Aurora User Guide</i>. </p>"
|
||||
},
|
||||
"DomainIAMRoleName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
|
|||
|
|
@ -1069,7 +1069,8 @@
|
|||
{"shape":"BucketNotFoundFault"},
|
||||
{"shape":"InsufficientS3BucketPolicyFault"},
|
||||
{"shape":"InvalidS3KeyPrefixFault"},
|
||||
{"shape":"InvalidS3BucketNameFault"}
|
||||
{"shape":"InvalidS3BucketNameFault"},
|
||||
{"shape":"InvalidClusterStateFault"}
|
||||
],
|
||||
"documentation":"<p>Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.</p>"
|
||||
},
|
||||
|
|
@ -1218,7 +1219,8 @@
|
|||
"resultWrapper":"ModifyClusterMaintenanceResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"}
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"InvalidClusterStateFault"}
|
||||
],
|
||||
"documentation":"<p>Modifies the maintenance settings of a cluster.</p>"
|
||||
},
|
||||
|
|
@ -1374,6 +1376,23 @@
|
|||
],
|
||||
"documentation":"<p>Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.</p>"
|
||||
},
|
||||
"PauseCluster":{
|
||||
"name":"PauseCluster",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"PauseClusterMessage"},
|
||||
"output":{
|
||||
"shape":"PauseClusterResult",
|
||||
"resultWrapper":"PauseClusterResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"InvalidClusterStateFault"}
|
||||
],
|
||||
"documentation":"<p>Pauses a cluster.</p>"
|
||||
},
|
||||
"PurchaseReservedNodeOffering":{
|
||||
"name":"PurchaseReservedNodeOffering",
|
||||
"http":{
|
||||
|
|
@ -1513,6 +1532,23 @@
|
|||
],
|
||||
"documentation":"<p>Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.</p> <p>You cannot use <code>RestoreTableFromClusterSnapshot</code> to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call <code>RestoreTableFromClusterSnapshot</code>. When you have renamed your original table, then you can pass the original name of the table as the <code>NewTableName</code> parameter value in the call to <code>RestoreTableFromClusterSnapshot</code>. This way, you can replace the original table with the table created from the snapshot.</p>"
|
||||
},
|
||||
"ResumeCluster":{
|
||||
"name":"ResumeCluster",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ResumeClusterMessage"},
|
||||
"output":{
|
||||
"shape":"ResumeClusterResult",
|
||||
"resultWrapper":"ResumeClusterResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"InvalidClusterStateFault"}
|
||||
],
|
||||
"documentation":"<p>Resumes a paused cluster.</p>"
|
||||
},
|
||||
"RevokeClusterSecurityGroupIngress":{
|
||||
"name":"RevokeClusterSecurityGroupIngress",
|
||||
"http":{
|
||||
|
|
@ -1655,7 +1691,8 @@
|
|||
"type":"string",
|
||||
"enum":[
|
||||
"restore-cluster",
|
||||
"recommend-node-config"
|
||||
"recommend-node-config",
|
||||
"resize-cluster"
|
||||
]
|
||||
},
|
||||
"AssociatedClusterList":{
|
||||
|
|
@ -1940,7 +1977,7 @@
|
|||
},
|
||||
"ClusterStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The current state of the cluster. Possible values are the following:</p> <ul> <li> <p> <code>available</code> </p> </li> <li> <p> <code>available, prep-for-resize</code> </p> </li> <li> <p> <code>available, resize-cleanup</code> </p> </li> <li> <p> <code>cancelling-resize</code> </p> </li> <li> <p> <code>creating</code> </p> </li> <li> <p> <code>deleting</code> </p> </li> <li> <p> <code>final-snapshot</code> </p> </li> <li> <p> <code>hardware-failure</code> </p> </li> <li> <p> <code>incompatible-hsm</code> </p> </li> <li> <p> <code>incompatible-network</code> </p> </li> <li> <p> <code>incompatible-parameters</code> </p> </li> <li> <p> <code>incompatible-restore</code> </p> </li> <li> <p> <code>modifying</code> </p> </li> <li> <p> <code>rebooting</code> </p> </li> <li> <p> <code>renaming</code> </p> </li> <li> <p> <code>resizing</code> </p> </li> <li> <p> <code>rotating-keys</code> </p> </li> <li> <p> <code>storage-full</code> </p> </li> <li> <p> <code>updating-hsm</code> </p> </li> </ul>"
|
||||
"documentation":"<p> The current state of the cluster. Possible values are the following:</p> <ul> <li> <p> <code>available</code> </p> </li> <li> <p> <code>available, prep-for-resize</code> </p> </li> <li> <p> <code>available, resize-cleanup</code> </p> </li> <li> <p> <code>cancelling-resize</code> </p> </li> <li> <p> <code>creating</code> </p> </li> <li> <p> <code>deleting</code> </p> </li> <li> <p> <code>final-snapshot</code> </p> </li> <li> <p> <code>hardware-failure</code> </p> </li> <li> <p> <code>incompatible-hsm</code> </p> </li> <li> <p> <code>incompatible-network</code> </p> </li> <li> <p> <code>incompatible-parameters</code> </p> </li> <li> <p> <code>incompatible-restore</code> </p> </li> <li> <p> <code>modifying</code> </p> </li> <li> <p> <code>paused</code> </p> </li> <li> <p> <code>rebooting</code> </p> </li> <li> <p> <code>renaming</code> </p> </li> <li> <p> <code>resizing</code> </p> </li> <li> <p> <code>rotating-keys</code> </p> </li> <li> <p> <code>storage-full</code> </p> </li> <li> <p> <code>updating-hsm</code> </p> </li> </ul>"
|
||||
},
|
||||
"ClusterAvailabilityStatus":{
|
||||
"shape":"String",
|
||||
|
|
@ -4001,7 +4038,7 @@
|
|||
"members":{
|
||||
"ActionType":{
|
||||
"shape":"ActionType",
|
||||
"documentation":"<p>The action type to evaluate for possible node configurations. Specify \"restore-cluster\" to get configuration combinations based on an existing snapshot. Specify \"recommend-node-config\" to get configuration recommendations based on an existing cluster or snapshot. </p>"
|
||||
"documentation":"<p>The action type to evaluate for possible node configurations. Specify \"restore-cluster\" to get configuration combinations based on an existing snapshot. Specify \"recommend-node-config\" to get configuration recommendations based on an existing cluster or snapshot. Specify \"resize-cluster\" to get configuration combinations for elastic resize based on an existing cluster. </p>"
|
||||
},
|
||||
"ClusterIdentifier":{
|
||||
"shape":"String",
|
||||
|
|
@ -5928,6 +5965,22 @@
|
|||
"locationName":"Parameter"
|
||||
}
|
||||
},
|
||||
"PauseClusterMessage":{
|
||||
"type":"structure",
|
||||
"required":["ClusterIdentifier"],
|
||||
"members":{
|
||||
"ClusterIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of the cluster to be paused.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PauseClusterResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Cluster":{"shape":"Cluster"}
|
||||
}
|
||||
},
|
||||
"PendingActionsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
|
|
@ -6274,10 +6327,7 @@
|
|||
},
|
||||
"ResizeClusterMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ClusterIdentifier",
|
||||
"NumberOfNodes"
|
||||
],
|
||||
"required":["ClusterIdentifier"],
|
||||
"members":{
|
||||
"ClusterIdentifier":{
|
||||
"shape":"String",
|
||||
|
|
@ -6623,6 +6673,22 @@
|
|||
"TableRestoreStatus":{"shape":"TableRestoreStatus"}
|
||||
}
|
||||
},
|
||||
"ResumeClusterMessage":{
|
||||
"type":"structure",
|
||||
"required":["ClusterIdentifier"],
|
||||
"members":{
|
||||
"ClusterIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of the cluster to be resumed.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ResumeClusterResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Cluster":{"shape":"Cluster"}
|
||||
}
|
||||
},
|
||||
"RevisionTarget":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -6798,7 +6864,7 @@
|
|||
},
|
||||
"Schedule":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.</p> <p>Format of at expressions is \"<code>at(yyyy-mm-ddThh:mm:ss)</code>\". For example, \"<code>at(2016-03-04T17:27:00)</code>\".</p> <p>Format of cron expressions is \"<code>cron(Minutes Hours Day-of-month Month Day-of-week Year)</code>\". For example, \"<code>cron(0, 10, *, *, MON, *)</code>\". For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions\">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>"
|
||||
"documentation":"<p>The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.</p> <p>Format of at expressions is \"<code>at(yyyy-mm-ddThh:mm:ss)</code>\". For example, \"<code>at(2016-03-04T17:27:00)</code>\".</p> <p>Format of cron expressions is \"<code>cron(Minutes Hours Day-of-month Month Day-of-week Year)</code>\". For example, \"<code>cron(0 10 ? * MON *)</code>\". For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions\">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>"
|
||||
},
|
||||
"IamRole":{
|
||||
"shape":"String",
|
||||
|
|
@ -6922,6 +6988,14 @@
|
|||
"ResizeCluster":{
|
||||
"shape":"ResizeClusterMessage",
|
||||
"documentation":"<p>An action that runs a <code>ResizeCluster</code> API operation. </p>"
|
||||
},
|
||||
"PauseCluster":{
|
||||
"shape":"PauseClusterMessage",
|
||||
"documentation":"<p>An action that runs a <code>PauseCluster</code> API operation. </p>"
|
||||
},
|
||||
"ResumeCluster":{
|
||||
"shape":"ResumeClusterMessage",
|
||||
"documentation":"<p>An action that runs a <code>ResumeCluster</code> API operation. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The action type that specifies an Amazon Redshift API operation that is supported by the Amazon Redshift scheduler. </p>"
|
||||
|
|
@ -6940,7 +7014,11 @@
|
|||
},
|
||||
"ScheduledActionTypeValues":{
|
||||
"type":"string",
|
||||
"enum":["ResizeCluster"]
|
||||
"enum":[
|
||||
"ResizeCluster",
|
||||
"PauseCluster",
|
||||
"ResumeCluster"
|
||||
]
|
||||
},
|
||||
"ScheduledActionsMessage":{
|
||||
"type":"structure",
|
||||
|
|
|
|||
|
|
@ -277,7 +277,7 @@
|
|||
{"shape":"ProvisionedThroughputExceededException"},
|
||||
{"shape":"InvalidImageFormatException"}
|
||||
],
|
||||
"documentation":"<p>Detects faces within an image that is provided as input.</p> <p> <code>DetectFaces</code> detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of beard, sunglasses, and so on. </p> <p>The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence. </p> <p>You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p> <note> <p>This is a stateless API operation. That is, the operation does not persist any data.</p> </note> <p>This operation requires permissions to perform the <code>rekognition:DetectFaces</code> action. </p>"
|
||||
"documentation":"<p>Detects faces within an image that is provided as input.</p> <p> <code>DetectFaces</code> detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of beard, sunglasses, and so on. </p> <p>The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence. </p> <p>You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p> <note> <p>This is a stateless API operation. That is, the operation does not persist any data.</p> </note> <p>This operation requires permissions to perform the <code>rekognition:DetectFaces</code> action. </p>"
|
||||
},
|
||||
"DetectLabels":{
|
||||
"name":"DetectLabels",
|
||||
|
|
@ -472,6 +472,25 @@
|
|||
],
|
||||
"documentation":"<p>Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>.</p> <p>The person path tracking operation is started by a call to <code>StartPersonTracking</code> which returns a job identifier (<code>JobId</code>). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartPersonTracking</code>.</p> <p>To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetPersonTracking</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>.</p> <p> <code>GetPersonTracking</code> returns an array, <code>Persons</code>, of tracked persons and the time(s) their paths were tracked in the video. </p> <note> <p> <code>GetPersonTracking</code> only returns the default facial attributes (<code>BoundingBox</code>, <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed in the <code>Face</code> object of the following response syntax are not returned. </p> <p>For more information, see FaceDetail in the Amazon Rekognition Developer Guide.</p> </note> <p>By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying <code>INDEX</code> for the <code>SortBy</code> input parameter.</p> <p>Use the <code>MaxResults</code> parameter to limit the number of items returned. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetPersonTracking</code> and populate the <code>NextToken</code> request parameter with the token value returned from the previous call to <code>GetPersonTracking</code>.</p>"
|
||||
},
|
||||
"GetTextDetection":{
|
||||
"name":"GetTextDetection",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetTextDetectionRequest"},
|
||||
"output":{"shape":"GetTextDetectionResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InternalServerError"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"InvalidPaginationTokenException"},
|
||||
{"shape":"ProvisionedThroughputExceededException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p>Gets the text detection results of a Amazon Rekognition Video analysis started by <a>StartTextDetection</a>.</p> <p>Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by calling <a>StartTextDetection</a> which returns a job identifier (<code>JobId</code>) When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartTextDetection</code>. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. if so, call <code>GetTextDetection</code> and pass the job identifier (<code>JobId</code>) from the initial call of <code>StartLabelDetection</code>.</p> <p> <code>GetTextDetection</code> returns an array of detected text (<code>TextDetections</code>) sorted by the time the text was detected, up to 50 words per frame of video.</p> <p>Each element of the array includes the detected text, the precentage confidence in the acuracy of the detected text, the time the text was detected, bounding box information for where the text was located, and unique identifiers for words and their lines.</p> <p>Use MaxResults parameter to limit the number of text detections returned. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetTextDetection</code> and populate the <code>NextToken</code> request parameter with the token value returned from the previous call to <code>GetTextDetection</code>.</p>"
|
||||
},
|
||||
"IndexFaces":{
|
||||
"name":"IndexFaces",
|
||||
"http":{
|
||||
|
|
@ -781,6 +800,28 @@
|
|||
],
|
||||
"documentation":"<p>Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>. To tell <code>StartStreamProcessor</code> which stream processor to start, use the value of the <code>Name</code> field specified in the call to <code>CreateStreamProcessor</code>.</p>"
|
||||
},
|
||||
"StartTextDetection":{
|
||||
"name":"StartTextDetection",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartTextDetectionRequest"},
|
||||
"output":{"shape":"StartTextDetectionResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"IdempotentParameterMismatchException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"InvalidS3ObjectException"},
|
||||
{"shape":"InternalServerError"},
|
||||
{"shape":"VideoTooLargeException"},
|
||||
{"shape":"ProvisionedThroughputExceededException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p>Starts asynchronous detection of text in a stored video.</p> <p>Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartTextDetection</code> returns a job identifier (<code>JobId</code>) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p> <p>To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. if so, call <a>GetTextDetection</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartTextDetection</code>. </p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"StopProjectVersion":{
|
||||
"name":"StopProjectVersion",
|
||||
"http":{
|
||||
|
|
@ -901,6 +942,16 @@
|
|||
},
|
||||
"documentation":"<p>Identifies the bounding box around the label, face, or text. The <code>left</code> (x-coordinate) and <code>top</code> (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0). </p> <p>The <code>top</code> and <code>left</code> values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a <code>left</code> value of 0.5 (350/700) and a <code>top</code> value of 0.25 (50/200).</p> <p>The <code>width</code> and <code>height</code> values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1. </p> <note> <p> The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the <code>left</code> or <code>top</code> values. </p> </note>"
|
||||
},
|
||||
"BoundingBoxHeight":{
|
||||
"type":"float",
|
||||
"max":1,
|
||||
"min":0
|
||||
},
|
||||
"BoundingBoxWidth":{
|
||||
"type":"float",
|
||||
"max":1,
|
||||
"min":0
|
||||
},
|
||||
"Celebrity":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1646,6 +1697,17 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DetectTextFilters":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"WordFilter":{"shape":"DetectionFilter"},
|
||||
"RegionsOfInterest":{
|
||||
"shape":"RegionsOfInterest",
|
||||
"documentation":"<p> A Filter focusing on a certain area of the image. Uses a <code>BoundingBox</code> object to set the region of the image.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A set of optional parameters that you can use to set the criteria that the text must meet to be included in your response. <code>WordFilter</code> looks at a word’s height, width, and minimum confidence. <code>RegionOfInterest</code> lets you set a specific region of the image to look for text in. </p>"
|
||||
},
|
||||
"DetectTextRequest":{
|
||||
"type":"structure",
|
||||
"required":["Image"],
|
||||
|
|
@ -1653,6 +1715,10 @@
|
|||
"Image":{
|
||||
"shape":"Image",
|
||||
"documentation":"<p>The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes. </p> <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see Images in the Amazon Rekognition developer guide.</p>"
|
||||
},
|
||||
"Filters":{
|
||||
"shape":"DetectTextFilters",
|
||||
"documentation":"<p>Optional parameters that let you set the criteria that the text must meet to be included in your response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1662,9 +1728,31 @@
|
|||
"TextDetections":{
|
||||
"shape":"TextDetectionList",
|
||||
"documentation":"<p>An array of text that was detected in the input image.</p>"
|
||||
},
|
||||
"TextModelVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The model version used to detect text.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DetectionFilter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"MinConfidence":{
|
||||
"shape":"Percent",
|
||||
"documentation":"<p>Sets confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 0.5 and 1 as Text in Video will not return any result below 0.5.</p>"
|
||||
},
|
||||
"MinBoundingBoxHeight":{
|
||||
"shape":"BoundingBoxHeight",
|
||||
"documentation":"<p>Sets the minimum height of the word bounding box. Words with bounding box heights lesser than this value will be excluded from the result. Value is relative to the video frame height.</p>"
|
||||
},
|
||||
"MinBoundingBoxWidth":{
|
||||
"shape":"BoundingBoxWidth",
|
||||
"documentation":"<p>Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than this value will be excluded from the result. Value is relative to the video frame width.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A set of parameters that allow you to filter out certain results from your returned results.</p>"
|
||||
},
|
||||
"Emotion":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1933,7 +2021,7 @@
|
|||
},
|
||||
"FaceMatchThreshold":{
|
||||
"shape":"Percent",
|
||||
"documentation":"<p>Minimum face match confidence score that must be met to return a result for a recognized face. Default is 70. 0 is the lowest confidence. 100 is the highest confidence.</p>"
|
||||
"documentation":"<p>Minimum face match confidence score that must be met to return a result for a recognized face. Default is 80. 0 is the lowest confidence. 100 is the highest confidence.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Input face recognition parameters for an Amazon Rekognition stream processor. <code>FaceRecognitionSettings</code> is a request parameter for <a>CreateStreamProcessor</a>.</p>"
|
||||
|
|
@ -2294,6 +2382,50 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"GetTextDetectionRequest":{
|
||||
"type":"structure",
|
||||
"required":["JobId"],
|
||||
"members":{
|
||||
"JobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p>Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to <code>StartTextDetection</code>.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetTextDetectionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"JobStatus":{
|
||||
"shape":"VideoJobStatus",
|
||||
"documentation":"<p>Current status of the text detection job.</p>"
|
||||
},
|
||||
"StatusMessage":{
|
||||
"shape":"StatusMessage",
|
||||
"documentation":"<p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>"
|
||||
},
|
||||
"VideoMetadata":{"shape":"VideoMetadata"},
|
||||
"TextDetections":{
|
||||
"shape":"TextDetectionResults",
|
||||
"documentation":"<p>An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of text.</p>"
|
||||
},
|
||||
"TextModelVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Version number of the text detection model that was used to detect text.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GroundTruthManifest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3211,6 +3343,22 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"RegionOfInterest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"BoundingBox":{
|
||||
"shape":"BoundingBox",
|
||||
"documentation":"<p>The box representing a region of interest on screen.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies a location within the frame that Rekognition checks for text. Uses a <code>BoundingBox</code> object to set a region of the screen.</p> <p>A word is included in the region if the word is more than half in that region. If there is more than one region, the word will be compared with all regions of the screen. Any word more than half in a region is kept in the results.</p>"
|
||||
},
|
||||
"RegionsOfInterest":{
|
||||
"type":"list",
|
||||
"member":{"shape":"RegionOfInterest"},
|
||||
"max":10,
|
||||
"min":0
|
||||
},
|
||||
"RekognitionUniqueId":{
|
||||
"type":"string",
|
||||
"pattern":"[0-9A-Za-z]*"
|
||||
|
|
@ -3645,6 +3793,49 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"StartTextDetectionFilters":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"WordFilter":{
|
||||
"shape":"DetectionFilter",
|
||||
"documentation":"<p>Filters focusing on qualities of the text, such as confidence or size.</p>"
|
||||
},
|
||||
"RegionsOfInterest":{
|
||||
"shape":"RegionsOfInterest",
|
||||
"documentation":"<p>Filter focusing on a certain area of the frame. Uses a <code>BoundingBox</code> object to set the region of the screen.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Set of optional parameters that let you set the criteria text must meet to be included in your response. <code>WordFilter</code> looks at a word's height, width and minimum confidence. <code>RegionOfInterest</code> lets you set a specific region of the screen to look for text in.</p>"
|
||||
},
|
||||
"StartTextDetectionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Video"],
|
||||
"members":{
|
||||
"Video":{"shape":"Video"},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartTextDetection</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidentaly started more than once.</p>"
|
||||
},
|
||||
"NotificationChannel":{"shape":"NotificationChannel"},
|
||||
"JobTag":{
|
||||
"shape":"JobTag",
|
||||
"documentation":"<p>An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
|
||||
},
|
||||
"Filters":{
|
||||
"shape":"StartTextDetectionFilters",
|
||||
"documentation":"<p>Optional parameters that let you set criteria the text must meet to be included in your response.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartTextDetectionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"JobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p>Identifier for the text detection job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetTextDetection</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StatusMessage":{"type":"string"},
|
||||
"StopProjectVersionRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -3832,6 +4023,24 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"TextDetection"}
|
||||
},
|
||||
"TextDetectionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Timestamp":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time, in milliseconds from the start of the video, that the text was detected.</p>"
|
||||
},
|
||||
"TextDetection":{
|
||||
"shape":"TextDetection",
|
||||
"documentation":"<p>Details about text detected in a video.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about text detected in a video. Incudes the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.</p>"
|
||||
},
|
||||
"TextDetectionResults":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TextDetectionResult"}
|
||||
},
|
||||
"TextTypes":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -3967,7 +4176,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours. </p>",
|
||||
"documentation":"<p>The file size or duration of the supplied media is too large. The maximum file size is 10GB. The maximum duration is 6 hours. </p>",
|
||||
"exception":true
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -1555,10 +1555,12 @@
|
|||
"RobotDeploymentNoResponse",
|
||||
"RobotAgentConnectionTimeout",
|
||||
"GreengrassDeploymentFailed",
|
||||
"InvalidGreengrassGroup",
|
||||
"MissingRobotArchitecture",
|
||||
"MissingRobotApplicationArchitecture",
|
||||
"MissingRobotDeploymentResource",
|
||||
"GreengrassGroupVersionDoesNotExist",
|
||||
"LambdaDeleted",
|
||||
"ExtractingBundleFailure",
|
||||
"PreLaunchFileFailure",
|
||||
"PostLaunchFileFailure",
|
||||
|
|
@ -2192,7 +2194,12 @@
|
|||
"min":0
|
||||
},
|
||||
"GenericInteger":{"type":"integer"},
|
||||
"GenericString":{"type":"string"},
|
||||
"GenericString":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":0,
|
||||
"pattern":".*"
|
||||
},
|
||||
"IamRole":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
|
|
@ -2258,6 +2265,10 @@
|
|||
"portForwardingConfig":{
|
||||
"shape":"PortForwardingConfig",
|
||||
"documentation":"<p>The port forwarding configuration.</p>"
|
||||
},
|
||||
"streamUI":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Boolean indicating whether a streaming session will be configured for the application. If <code>True</code>, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and luanch the component. It must have a graphical user interface. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a launch configuration.</p>"
|
||||
|
|
@ -2551,7 +2562,8 @@
|
|||
"NonEmptyString":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1
|
||||
"min":1,
|
||||
"pattern":".+"
|
||||
},
|
||||
"NonSystemPort":{
|
||||
"type":"integer",
|
||||
|
|
@ -2709,6 +2721,8 @@
|
|||
},
|
||||
"RenderingEngineVersionType":{
|
||||
"type":"string",
|
||||
"max":4,
|
||||
"min":1,
|
||||
"pattern":"1.x"
|
||||
},
|
||||
"ResourceAlreadyExistsException":{
|
||||
|
|
@ -3393,6 +3407,8 @@
|
|||
},
|
||||
"SimulationSoftwareSuiteVersionType":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":0,
|
||||
"pattern":"7|9|Kinetic|Melodic|Dashing"
|
||||
},
|
||||
"SimulationTimeMillis":{"type":"long"},
|
||||
|
|
@ -3450,7 +3466,8 @@
|
|||
"members":{
|
||||
"clientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
|
||||
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"batchPolicy":{
|
||||
"shape":"BatchPolicy",
|
||||
|
|
@ -3842,6 +3859,8 @@
|
|||
},
|
||||
"VersionQualifier":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"ALL"
|
||||
},
|
||||
"errorMessage":{"type":"string"}
|
||||
|
|
|
|||
|
|
@ -62,6 +62,21 @@
|
|||
"input":{"shape":"DeleteAccessPointPolicyRequest"},
|
||||
"documentation":"<p>Deletes the access point policy for the specified access point.</p>"
|
||||
},
|
||||
"DeleteJobTagging":{
|
||||
"name":"DeleteJobTagging",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/v20180820/jobs/{id}/tagging"
|
||||
},
|
||||
"input":{"shape":"DeleteJobTaggingRequest"},
|
||||
"output":{"shape":"DeleteJobTaggingResult"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Delete the tags on a Amazon S3 batch operations job, if any.</p>"
|
||||
},
|
||||
"DeletePublicAccessBlock":{
|
||||
"name":"DeletePublicAccessBlock",
|
||||
"http":{
|
||||
|
|
@ -117,6 +132,21 @@
|
|||
"output":{"shape":"GetAccessPointPolicyStatusResult"},
|
||||
"documentation":"<p>Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html\">Managing Data Access with Amazon S3 Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
|
||||
},
|
||||
"GetJobTagging":{
|
||||
"name":"GetJobTagging",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/v20180820/jobs/{id}/tagging"
|
||||
},
|
||||
"input":{"shape":"GetJobTaggingRequest"},
|
||||
"output":{"shape":"GetJobTaggingResult"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Retrieve the tags on a Amazon S3 batch operations job.</p>"
|
||||
},
|
||||
"GetPublicAccessBlock":{
|
||||
"name":"GetPublicAccessBlock",
|
||||
"http":{
|
||||
|
|
@ -168,6 +198,26 @@
|
|||
},
|
||||
"documentation":"<p>Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.</p>"
|
||||
},
|
||||
"PutJobTagging":{
|
||||
"name":"PutJobTagging",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/v20180820/jobs/{id}/tagging"
|
||||
},
|
||||
"input":{
|
||||
"shape":"PutJobTaggingRequest",
|
||||
"locationName":"PutJobTaggingRequest",
|
||||
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
|
||||
},
|
||||
"output":{"shape":"PutJobTaggingResult"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"TooManyTagsException"}
|
||||
],
|
||||
"documentation":"<p>Replace the set of tags on a Amazon S3 batch operations job.</p>"
|
||||
},
|
||||
"PutPublicAccessBlock":{
|
||||
"name":"PutPublicAccessBlock",
|
||||
"http":{
|
||||
|
|
@ -353,6 +403,10 @@
|
|||
"RoleArn":{
|
||||
"shape":"IAMRoleArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role that batch operations will use to execute this job's operation on each object in the manifest.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"S3TagSet",
|
||||
"documentation":"<p>An optional set of tags to associate with the job when it is created.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -408,6 +462,32 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DeleteJobTaggingRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"JobId"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The account ID for the Amazon Web Services account associated with the Amazon S3 batch operations job you want to remove tags from.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-account-id"
|
||||
},
|
||||
"JobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p>The ID for the job whose tags you want to delete.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"id"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteJobTaggingResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeletePublicAccessBlockRequest":{
|
||||
"type":"structure",
|
||||
"required":["AccountId"],
|
||||
|
|
@ -562,6 +642,36 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"GetJobTaggingRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"JobId"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The account ID for the Amazon Web Services account associated with the Amazon S3 batch operations job you want to retrieve tags for.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-account-id"
|
||||
},
|
||||
"JobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p>The ID for the job whose tags you want to retrieve.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"id"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetJobTaggingResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Tags":{
|
||||
"shape":"S3TagSet",
|
||||
"documentation":"<p>The set of tags associated with the job.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetPublicAccessBlockOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1245,6 +1355,37 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"PutJobTaggingRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"JobId",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The account ID for the Amazon Web Services account associated with the Amazon S3 batch operations job you want to replace tags on.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-account-id"
|
||||
},
|
||||
"JobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p>The ID for the job whose tags you want to replace.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"id"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"S3TagSet",
|
||||
"documentation":"<p>The set of tags to associate with the job.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PutJobTaggingResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"PutPublicAccessBlockRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1661,6 +1802,13 @@
|
|||
"documentation":"<p/>",
|
||||
"exception":true
|
||||
},
|
||||
"TooManyTagsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"UpdateJobPriorityRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServerException"}
|
||||
],
|
||||
"documentation":"<p>Returns information about human loops, given the specified parameters.</p>"
|
||||
"documentation":"<p>Returns information about human loops, given the specified parameters. If a human loop was deleted, it will not be included.</p>"
|
||||
},
|
||||
"StartHumanLoop":{
|
||||
"name":"StartHumanLoop",
|
||||
|
|
@ -71,7 +71,8 @@
|
|||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ServiceQuotaExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ConflictException"}
|
||||
],
|
||||
"documentation":"<p>Starts a human loop, provided that at least one activation condition is met.</p>"
|
||||
},
|
||||
|
|
@ -93,7 +94,15 @@
|
|||
}
|
||||
},
|
||||
"shapes":{
|
||||
"Boolean":{"type":"boolean"},
|
||||
"ConflictException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"FailureReason"}
|
||||
},
|
||||
"documentation":"<p>Your request has the same name as another active human loop but has different input data. You cannot start two human loops with the same name and different input data.</p>",
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"ContentClassifier":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -129,7 +138,7 @@
|
|||
"members":{
|
||||
"HumanLoopName":{
|
||||
"shape":"HumanLoopName",
|
||||
"documentation":"<p>The name of the human loop.</p>",
|
||||
"documentation":"<p>The unique name of the human loop.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"HumanLoopName"
|
||||
}
|
||||
|
|
@ -138,17 +147,16 @@
|
|||
"DescribeHumanLoopResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CreationTimestamp",
|
||||
"CreationTime",
|
||||
"HumanLoopStatus",
|
||||
"HumanLoopName",
|
||||
"HumanLoopArn",
|
||||
"FlowDefinitionArn",
|
||||
"HumanLoopInput"
|
||||
"FlowDefinitionArn"
|
||||
],
|
||||
"members":{
|
||||
"CreationTimestamp":{
|
||||
"CreationTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The timestamp when Amazon Augmented AI created the human loop.</p>"
|
||||
"documentation":"<p>The creation time when Amazon Augmented AI created the human loop.</p>"
|
||||
},
|
||||
"FailureReason":{
|
||||
"shape":"String",
|
||||
|
|
@ -174,12 +182,8 @@
|
|||
"shape":"FlowDefinitionArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the flow definition.</p>"
|
||||
},
|
||||
"HumanLoopInput":{
|
||||
"shape":"HumanLoopInputContent",
|
||||
"documentation":"<p>An object containing information about the human loop input.</p>"
|
||||
},
|
||||
"HumanLoopOutput":{
|
||||
"shape":"HumanLoopOutputContent",
|
||||
"shape":"HumanLoopOutput",
|
||||
"documentation":"<p>An object containing information about the output of the human loop.</p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -193,45 +197,32 @@
|
|||
"max":1024,
|
||||
"pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:flow-definition/.*"
|
||||
},
|
||||
"HumanLoopActivationReason":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ConditionsMatched":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>True if the specified conditions were matched to trigger the human loop.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about why a human loop was triggered. If at least one activation reason is evaluated to be true, the human loop is activated.</p>"
|
||||
},
|
||||
"HumanLoopActivationResults":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"HumanLoopActivationReason":{
|
||||
"shape":"HumanLoopActivationReason",
|
||||
"documentation":"<p>An object containing information about why a human loop was triggered.</p>"
|
||||
},
|
||||
"HumanLoopActivationConditionsEvaluationResults":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A copy of the human loop activation conditions of the flow definition, augmented with the results of evaluating those conditions on the input provided to the <code>StartHumanLoop</code> operation.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the corresponding flow definition's human loop activation condition evaluation. Null if <code>StartHumanLoop</code> was invoked directly.</p>"
|
||||
},
|
||||
"HumanLoopArn":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:human-loop/.*"
|
||||
},
|
||||
"HumanLoopInputContent":{
|
||||
"HumanLoopDataAttributes":{
|
||||
"type":"structure",
|
||||
"required":["ContentClassifiers"],
|
||||
"members":{
|
||||
"ContentClassifiers":{
|
||||
"shape":"ContentClassifiers",
|
||||
"documentation":"<p>Declares that your content is free of personally identifiable information or adult content.</p> <p>Amazon SageMaker can restrict the Amazon Mechanical Turk workers who can view your task based on this information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Attributes of the data specified by the customer. Use these to describe the data to be labeled.</p>"
|
||||
},
|
||||
"HumanLoopInput":{
|
||||
"type":"structure",
|
||||
"required":["InputContent"],
|
||||
"members":{
|
||||
"InputContent":{
|
||||
"shape":"InputContent",
|
||||
"documentation":"<p>Serialized input from the human loop.</p>"
|
||||
"documentation":"<p>Serialized input from the human loop. The input must be a string representation of a file in JSON format.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An object containing the input.</p>"
|
||||
"documentation":"<p>An object containing the human loop input in JSON format.</p>"
|
||||
},
|
||||
"HumanLoopName":{
|
||||
"type":"string",
|
||||
|
|
@ -239,13 +230,13 @@
|
|||
"min":1,
|
||||
"pattern":"^[a-z0-9](-*[a-z0-9])*$"
|
||||
},
|
||||
"HumanLoopOutputContent":{
|
||||
"HumanLoopOutput":{
|
||||
"type":"structure",
|
||||
"required":["OutputS3Uri"],
|
||||
"members":{
|
||||
"OutputS3Uri":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output. The output is stored at the following location: <code>s3://S3OutputPath/HumanLoopName/CreationTime/output.json</code>.</p>"
|
||||
"documentation":"<p>The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about where the human output will be stored.</p>"
|
||||
|
|
@ -290,17 +281,6 @@
|
|||
},
|
||||
"documentation":"<p>Summary information about the human loop.</p>"
|
||||
},
|
||||
"HumanReviewDataAttributes":{
|
||||
"type":"structure",
|
||||
"required":["ContentClassifiers"],
|
||||
"members":{
|
||||
"ContentClassifiers":{
|
||||
"shape":"ContentClassifiers",
|
||||
"documentation":"<p>Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Attributes of the data specified by the customer. Use these to describe the data to be labeled.</p>"
|
||||
},
|
||||
"InputContent":{
|
||||
"type":"string",
|
||||
"max":4194304
|
||||
|
|
@ -316,19 +296,26 @@
|
|||
},
|
||||
"ListHumanLoopsRequest":{
|
||||
"type":"structure",
|
||||
"required":["FlowDefinitionArn"],
|
||||
"members":{
|
||||
"CreationTimeAfter":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>(Optional) The timestamp of the date when you want the human loops to begin. For example, <code>1551000000</code>.</p>",
|
||||
"documentation":"<p>(Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, <code>2020-02-24</code>.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"CreationTimeAfter"
|
||||
},
|
||||
"CreationTimeBefore":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>(Optional) The timestamp of the date before which you want the human loops to begin. For example, <code>1550000000</code>.</p>",
|
||||
"documentation":"<p>(Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, <code>2020-02-24</code>.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"CreationTimeBefore"
|
||||
},
|
||||
"FlowDefinitionArn":{
|
||||
"shape":"FlowDefinitionArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of a flow definition.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"FlowDefinitionArn"
|
||||
},
|
||||
"SortOrder":{
|
||||
"shape":"SortOrder",
|
||||
"documentation":"<p>An optional value that specifies whether you want the results sorted in <code>Ascending</code> or <code>Descending</code> order.</p>",
|
||||
|
|
@ -416,11 +403,11 @@
|
|||
"documentation":"<p>The Amazon Resource Name (ARN) of the flow definition.</p>"
|
||||
},
|
||||
"HumanLoopInput":{
|
||||
"shape":"HumanLoopInputContent",
|
||||
"shape":"HumanLoopInput",
|
||||
"documentation":"<p>An object containing information about the human loop.</p>"
|
||||
},
|
||||
"DataAttributes":{
|
||||
"shape":"HumanReviewDataAttributes",
|
||||
"shape":"HumanLoopDataAttributes",
|
||||
"documentation":"<p>Attributes of the data specified by the customer.</p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -431,10 +418,6 @@
|
|||
"HumanLoopArn":{
|
||||
"shape":"HumanLoopArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the human loop.</p>"
|
||||
},
|
||||
"HumanLoopActivationResults":{
|
||||
"shape":"HumanLoopActivationResults",
|
||||
"documentation":"<p>An object containing information about the human loop activation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -474,5 +457,5 @@
|
|||
"exception":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Amazon Augmented AI (Augmented AI) (Preview) is a service that adds human judgment to any machine learning application. Human reviewers can take over when an AI application can't evaluate data with a high degree of confidence.</p> <p>From fraudulent bank transaction identification to document processing to image analysis, machine learning models can be trained to make decisions as well as or better than a human. Nevertheless, some decisions require contextual interpretation, such as when you need to decide whether an image is appropriate for a given audience. Content moderation guidelines are nuanced and highly dependent on context, and they vary between countries. When trying to apply AI in these situations, you can be forced to choose between \"ML only\" systems with unacceptably high error rates or \"human only\" systems that are expensive and difficult to scale, and that slow down decision making.</p> <p>This API reference includes information about API actions and data types you can use to interact with Augmented AI programmatically. </p> <p>You can create a flow definition against the Augmented AI API. Provide the Amazon Resource Name (ARN) of a flow definition to integrate AI service APIs, such as <code>Textract.AnalyzeDocument</code> and <code>Rekognition.DetectModerationLabels</code>. These AI services, in turn, invoke the <a>StartHumanLoop</a> API, which evaluates conditions under which humans will be invoked. If humans are required, Augmented AI creates a human loop. Results of human work are available asynchronously in Amazon Simple Storage Service (Amazon S3). You can use Amazon CloudWatch Events to detect human work results.</p> <p>You can find additional Augmented AI API documentation in the following reference guides: <a href=\"https://aws.amazon.com/rekognition/latest/dg/API_Reference.html\">Amazon Rekognition</a>, <a href=\"https://aws.amazon.com/sagemaker/latest/dg/API_Reference.html\">Amazon SageMaker</a>, and <a href=\"https://aws.amazon.com/textract/latest/dg/API_Reference.html\">Amazon Textract</a>.</p>"
|
||||
"documentation":"<p>Amazon Augmented AI (Augmented AI) (Preview) is a service that adds human judgment to any machine learning application. Human reviewers can take over when an AI application can't evaluate data with a high degree of confidence.</p> <p>From fraudulent bank transaction identification to document processing to image analysis, machine learning models can be trained to make decisions as well as or better than a human. Nevertheless, some decisions require contextual interpretation, such as when you need to decide whether an image is appropriate for a given audience. Content moderation guidelines are nuanced and highly dependent on context, and they vary between countries. When trying to apply AI in these situations, you can be forced to choose between \"ML only\" systems with unacceptably high error rates or \"human only\" systems that are expensive and difficult to scale, and that slow down decision making.</p> <p>This API reference includes information about API actions and data types you can use to interact with Augmented AI programmatically. </p> <p>You can create a flow definition against the Augmented AI API. Provide the Amazon Resource Name (ARN) of a flow definition to integrate AI service APIs, such as <code>Textract.AnalyzeDocument</code> and <code>Rekognition.DetectModerationLabels</code>. These AI services, in turn, invoke the <a>StartHumanLoop</a> API, which evaluates conditions under which humans will be invoked. If humans are required, Augmented AI creates a human loop. Results of human work are available asynchronously in Amazon Simple Storage Service (Amazon S3). You can use Amazon CloudWatch Events to detect human work results.</p> <p>You can find additional Augmented AI API documentation in the following reference guides: <a href=\"https://docs.aws.amazon.com/rekognition/latest/dg/API_Reference.html\">Amazon Rekognition</a>, <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/API_Reference.html\">Amazon SageMaker</a>, and <a href=\"https://docs.aws.amazon.com/textract/latest/dg/API_Reference.html\">Amazon Textract</a>.</p>"
|
||||
}
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -826,7 +826,8 @@
|
|||
"type":"string",
|
||||
"enum":[
|
||||
"EC2",
|
||||
"Fargate"
|
||||
"Fargate",
|
||||
"Lambda"
|
||||
]
|
||||
},
|
||||
"SavingsPlanProductTypeList":{
|
||||
|
|
@ -959,7 +960,8 @@
|
|||
"type":"string",
|
||||
"enum":[
|
||||
"AmazonEC2",
|
||||
"AmazonECS"
|
||||
"AmazonECS",
|
||||
"AWSLambda"
|
||||
]
|
||||
},
|
||||
"SavingsPlanRateServiceCodeList":{
|
||||
|
|
@ -968,7 +970,11 @@
|
|||
},
|
||||
"SavingsPlanRateUnit":{
|
||||
"type":"string",
|
||||
"enum":["Hrs"]
|
||||
"enum":[
|
||||
"Hrs",
|
||||
"Lambda-GB-Second",
|
||||
"Request"
|
||||
]
|
||||
},
|
||||
"SavingsPlanRateUsageType":{
|
||||
"type":"string",
|
||||
|
|
|
|||
|
|
@ -542,7 +542,10 @@
|
|||
"shape":"SecretVersionsToStagesMapType",
|
||||
"documentation":"<p>A list of all of the currently assigned <code>VersionStage</code> staging labels and the <code>VersionId</code> that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.</p> <note> <p>A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.</p> </note>"
|
||||
},
|
||||
"OwningService":{"shape":"OwningServiceType"}
|
||||
"OwningService":{
|
||||
"shape":"OwningServiceType",
|
||||
"documentation":"<p>Returns the name of the service that created this secret.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescriptionType":{
|
||||
|
|
@ -1057,7 +1060,7 @@
|
|||
},
|
||||
"SecretBinaryType":{
|
||||
"type":"blob",
|
||||
"max":10240,
|
||||
"max":65536,
|
||||
"min":0,
|
||||
"sensitive":true
|
||||
},
|
||||
|
|
@ -1087,7 +1090,7 @@
|
|||
},
|
||||
"RotationEnabled":{
|
||||
"shape":"RotationEnabledType",
|
||||
"documentation":"<p>Indicated whether automatic, scheduled rotation is enabled for this secret.</p>",
|
||||
"documentation":"<p>Indicates whether automatic, scheduled rotation is enabled for this secret.</p>",
|
||||
"box":true
|
||||
},
|
||||
"RotationLambdaARN":{
|
||||
|
|
@ -1125,7 +1128,10 @@
|
|||
"shape":"SecretVersionsToStagesMapType",
|
||||
"documentation":"<p>A list of all of the currently assigned <code>SecretVersionStage</code> staging labels and the <code>SecretVersionId</code> that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.</p> <note> <p>A version that does not have any <code>SecretVersionStage</code> is considered deprecated and subject to deletion. Such versions are not included in this list.</p> </note>"
|
||||
},
|
||||
"OwningService":{"shape":"OwningServiceType"}
|
||||
"OwningService":{
|
||||
"shape":"OwningServiceType",
|
||||
"documentation":"<p>Returns the name of the service that created the secret.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure that contains the details about a secret. It does not include the encrypted <code>SecretString</code> and <code>SecretBinary</code> values. To get those values, use the <a>GetSecretValue</a> operation.</p>"
|
||||
},
|
||||
|
|
@ -1140,7 +1146,7 @@
|
|||
},
|
||||
"SecretStringType":{
|
||||
"type":"string",
|
||||
"max":10240,
|
||||
"max":65536,
|
||||
"min":0,
|
||||
"sensitive":true
|
||||
},
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@
|
|||
{"shape":"InvalidAccessException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Disables the standards specified by the provided <code>StandardsSubscriptionArns</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html\">Standards Supported in AWS Security Hub</a>.</p>"
|
||||
"documentation":"<p>Disables the standards specified by the provided <code>StandardsSubscriptionArns</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html\">Security Standards</a> section of the <i>AWS Security Hub User Guide</i>.</p>"
|
||||
},
|
||||
"BatchEnableStandards":{
|
||||
"name":"BatchEnableStandards",
|
||||
|
|
@ -59,7 +59,7 @@
|
|||
{"shape":"InvalidAccessException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Enables the standards specified by the provided <code>standardsArn</code>.</p> <p>In this release, only CIS AWS Foundations standards are supported.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html\">Standards Supported in AWS Security Hub</a>.</p>"
|
||||
"documentation":"<p>Enables the standards specified by the provided <code>StandardsArn</code>. To obtain the ARN for a standard, use the <code> <a>DescribeStandards</a> </code> operation.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards.html\">Security Standards</a> section of the <i>AWS Security Hub User Guide</i>.</p>"
|
||||
},
|
||||
"BatchImportFindings":{
|
||||
"name":"BatchImportFindings",
|
||||
|
|
@ -126,7 +126,7 @@
|
|||
{"shape":"InvalidAccessException"},
|
||||
{"shape":"ResourceConflictException"}
|
||||
],
|
||||
"documentation":"<p>Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. To successfully create a member, you must use this action from an account that already has Security Hub enabled. To enable Security Hub, you can use the <a>EnableSecurityHub</a> operation.</p> <p>After you use <code>CreateMembers</code> to create member account associations in Security Hub, you must use the <a>InviteMembers</a> operation to invite the accounts to enable Security Hub and become member accounts in Security Hub.</p> <p>If the account owner accepts the invitation, the account becomes a member account in Security Hub, and a permission policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start to be sent to both the member and master accounts.</p> <p>To remove the association between the master and member accounts, use the <a>DisassociateFromMasterAccount</a> or <a>DisassociateMembers</a> operation.</p>"
|
||||
"documentation":"<p>Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. To successfully create a member, you must use this action from an account that already has Security Hub enabled. To enable Security Hub, you can use the <code> <a>EnableSecurityHub</a> </code> operation.</p> <p>After you use <code>CreateMembers</code> to create member account associations in Security Hub, you must use the <code> <a>InviteMembers</a> </code> operation to invite the accounts to enable Security Hub and become member accounts in Security Hub.</p> <p>If the account owner accepts the invitation, the account becomes a member account in Security Hub, and a permission policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start to be sent to both the member and master accounts.</p> <p>To remove the association between the master and member accounts, use the <code> <a>DisassociateFromMasterAccount</a> </code> or <code> <a>DisassociateMembers</a> </code> operation.</p>"
|
||||
},
|
||||
"DeclineInvitations":{
|
||||
"name":"DeclineInvitations",
|
||||
|
|
@ -260,6 +260,21 @@
|
|||
],
|
||||
"documentation":"<p>Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.</p>"
|
||||
},
|
||||
"DescribeStandards":{
|
||||
"name":"DescribeStandards",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/standards"
|
||||
},
|
||||
"input":{"shape":"DescribeStandardsRequest"},
|
||||
"output":{"shape":"DescribeStandardsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InvalidAccessException"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of the available standards in Security Hub.</p> <p>For each standard, the results include the standard ARN, the name, and a description. </p>"
|
||||
},
|
||||
"DescribeStandardsControls":{
|
||||
"name":"DescribeStandardsControls",
|
||||
"http":{
|
||||
|
|
@ -274,7 +289,7 @@
|
|||
{"shape":"InvalidAccessException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of compliance standards controls.</p> <p>For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.</p>"
|
||||
"documentation":"<p>Returns a list of security standards controls.</p> <p>For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.</p>"
|
||||
},
|
||||
"DisableImportFindingsForProduct":{
|
||||
"name":"DisableImportFindingsForProduct",
|
||||
|
|
@ -375,7 +390,7 @@
|
|||
{"shape":"ResourceConflictException"},
|
||||
{"shape":"AccessDeniedException"}
|
||||
],
|
||||
"documentation":"<p>Enables Security Hub for your account in the current Region or the Region you specify in the request.</p> <p>Enabling Security Hub also enables the CIS AWS Foundations standard.</p> <p>When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from AWS Config, Amazon GuardDuty, Amazon Inspector, and Amazon Macie.</p> <p>To learn more, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html\">Setting Up AWS Security Hub</a>.</p>"
|
||||
"documentation":"<p>Enables Security Hub for your account in the current Region or the Region you specify in the request.</p> <p>When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from AWS Config, Amazon GuardDuty, Amazon Inspector, and Amazon Macie.</p> <p>When you use the <code>EnableSecurityHub</code> operation to enable Security Hub, you also automatically enable the CIS AWS Foundations standard. You do not enable the Payment Card Industry Data Security Standard (PCI DSS) standard. To enable a standard, use the <code> <a>BatchEnableStandards</a> </code> operation. To disable a standard, use the <code> <a>BatchDisableStandards</a> </code> operation.</p> <p>To learn more, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-settingup.html\">Setting Up AWS Security Hub</a> in the <i>AWS Security Hub User Guide</i>.</p>"
|
||||
},
|
||||
"GetEnabledStandards":{
|
||||
"name":"GetEnabledStandards",
|
||||
|
|
@ -508,7 +523,7 @@
|
|||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from.</p> <p>Before you can use this action to invite a member, you must first use the <a>CreateMembers</a> action to create the member account in Security Hub.</p> <p>When the account owner accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from the member account.</p>"
|
||||
"documentation":"<p>Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from.</p> <p>Before you can use this action to invite a member, you must first use the <code> <a>CreateMembers</a> </code> action to create the member account in Security Hub.</p> <p>When the account owner accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from the member account.</p>"
|
||||
},
|
||||
"ListEnabledProductsForImport":{
|
||||
"name":"ListEnabledProductsForImport",
|
||||
|
|
@ -667,7 +682,7 @@
|
|||
{"shape":"InvalidAccessException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Used to control whether an individual compliance standard control is enabled or disabled.</p>"
|
||||
"documentation":"<p>Used to control whether an individual security standard control is enabled or disabled.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -1679,7 +1694,7 @@
|
|||
},
|
||||
"CompatibleRuntimes":{
|
||||
"shape":"NonEmptyStringList",
|
||||
"documentation":"<p>The layer's compatible runtimes. Maximum number of 5 items.</p> <p>Valid values: <code>nodejs8.10</code> | <code>nodejs10.x</code> | <code>nodejs12.x</code> | <code>java8</code> | <code>java11</code> | <code>python2.7</code> | <code>python3.6</code> | <code>python3.7</code> | <code>python3.8</code> | <code>dotnetcore1.0</code> | <code>dotnetcore2.1</code> | <code>go1.x</code> | <code>ruby2.5</code> | <code>provided</code> </p>"
|
||||
"documentation":"<p>The layer's compatible runtimes. Maximum number of 5 items.</p> <p>Valid values: <code>nodejs10.x</code> | <code>nodejs12.x</code> | <code>java8</code> | <code>java11</code> | <code>python2.7</code> | <code>python3.6</code> | <code>python3.7</code> | <code>python3.8</code> | <code>dotnetcore1.0</code> | <code>dotnetcore2.1</code> | <code>go1.x</code> | <code>ruby2.5</code> | <code>provided</code> </p>"
|
||||
},
|
||||
"CreatedDate":{
|
||||
"shape":"NonEmptyString",
|
||||
|
|
@ -1839,10 +1854,86 @@
|
|||
"OwnerName":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The display name of the owner of the S3 bucket.</p>"
|
||||
},
|
||||
"CreatedAt":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The date and time when the S3 bucket was created.</p>"
|
||||
},
|
||||
"ServerSideEncryptionConfiguration":{
|
||||
"shape":"AwsS3BucketServerSideEncryptionConfiguration",
|
||||
"documentation":"<p>The encryption rules that are applied to the S3 bucket.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The details of an Amazon S3 bucket.</p>"
|
||||
},
|
||||
"AwsS3BucketServerSideEncryptionByDefault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SSEAlgorithm":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>Server-side encryption algorithm to use for the default encryption.</p>"
|
||||
},
|
||||
"KMSMasterKeyID":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>AWS KMS customer master key (CMK) ID to use for the default encryption.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies the default server-side encryption to apply to new objects in the bucket.</p>"
|
||||
},
|
||||
"AwsS3BucketServerSideEncryptionConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Rules":{
|
||||
"shape":"AwsS3BucketServerSideEncryptionRules",
|
||||
"documentation":"<p>The encryption rules that are applied to the S3 bucket.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The encryption configuration for the S3 bucket.</p>"
|
||||
},
|
||||
"AwsS3BucketServerSideEncryptionRule":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ApplyServerSideEncryptionByDefault":{
|
||||
"shape":"AwsS3BucketServerSideEncryptionByDefault",
|
||||
"documentation":"<p>Specifies the default server-side encryption to apply to new objects in the bucket. If a <code>PUT</code> Object request doesn't specify any server-side encryption, this default encryption is applied.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An encryption rule to apply to the S3 bucket.</p>"
|
||||
},
|
||||
"AwsS3BucketServerSideEncryptionRules":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AwsS3BucketServerSideEncryptionRule"}
|
||||
},
|
||||
"AwsS3ObjectDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"LastModified":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The date and time when the object was last modified.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The opaque identifier assigned by a web server to a specific version of a resource found at a URL.</p>"
|
||||
},
|
||||
"VersionId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The version of the object.</p>"
|
||||
},
|
||||
"ContentType":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>A standard MIME type describing the format of the object data.</p>"
|
||||
},
|
||||
"ServerSideEncryption":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>If the object is stored using server-side encryption, the value of the server-side encryption algorithm used when storing this object in Amazon S3.</p>"
|
||||
},
|
||||
"SSEKMSKeyId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The identifier of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Details about an AWS S3 object.</p>"
|
||||
},
|
||||
"AwsSecurityFinding":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1870,7 +1961,7 @@
|
|||
},
|
||||
"ProductArn":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The ARN generated by Security Hub that uniquely identifies a third-party company (security-findings provider) after this provider's product (solution that generates findings) is registered with Security Hub. </p>"
|
||||
"documentation":"<p>The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.</p>"
|
||||
},
|
||||
"GeneratorId":{
|
||||
"shape":"NonEmptyString",
|
||||
|
|
@ -1958,7 +2049,7 @@
|
|||
},
|
||||
"Compliance":{
|
||||
"shape":"Compliance",
|
||||
"documentation":"<p>This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.</p>"
|
||||
"documentation":"<p>This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS AWS Foundations. Contains security standard-related finding details.</p>"
|
||||
},
|
||||
"VerificationState":{
|
||||
"shape":"VerificationState",
|
||||
|
|
@ -1968,6 +2059,10 @@
|
|||
"shape":"WorkflowState",
|
||||
"documentation":"<p>The workflow state of a finding. </p>"
|
||||
},
|
||||
"Workflow":{
|
||||
"shape":"Workflow",
|
||||
"documentation":"<p>Provides information about the status of the investigation into a finding.</p>"
|
||||
},
|
||||
"RecordState":{
|
||||
"shape":"RecordState",
|
||||
"documentation":"<p>The record state of a finding.</p>"
|
||||
|
|
@ -1981,7 +2076,7 @@
|
|||
"documentation":"<p>A user-defined note added to a finding.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides consistent format for the contents of the Security Hub-aggregated findings. <code>AwsSecurityFinding</code> format enables you to share findings between AWS security services and third-party solutions, and compliance checks.</p> <note> <p>A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and compliance checks.</p> </note>"
|
||||
"documentation":"<p>Provides consistent format for the contents of the Security Hub-aggregated findings. <code>AwsSecurityFinding</code> format enables you to share findings between AWS security services and third-party solutions, and security standards checks.</p> <note> <p>A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and standards checks.</p> </note>"
|
||||
},
|
||||
"AwsSecurityFindingFilters":{
|
||||
"type":"structure",
|
||||
|
|
@ -2280,7 +2375,7 @@
|
|||
},
|
||||
"ComplianceStatus":{
|
||||
"shape":"StringFilterList",
|
||||
"documentation":"<p>Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.</p>"
|
||||
"documentation":"<p>Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS AWS Foundations. Contains security standard-related finding details.</p>"
|
||||
},
|
||||
"VerificationState":{
|
||||
"shape":"StringFilterList",
|
||||
|
|
@ -2290,6 +2385,10 @@
|
|||
"shape":"StringFilterList",
|
||||
"documentation":"<p>The workflow state of a finding.</p>"
|
||||
},
|
||||
"WorkflowStatus":{
|
||||
"shape":"StringFilterList",
|
||||
"documentation":"<p>The status of the investigation into a finding. Allowed values are the following.</p> <ul> <li> <p> <code>NEW</code> - The initial state of a finding, before it is reviewed.</p> </li> <li> <p> <code>NOTIFIED</code> - Indicates that the resource owner has been notified about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.</p> </li> <li> <p> <code>SUPPRESSED</code> - The finding will not be reviewed again and will not be acted upon.</p> </li> <li> <p> <code>RESOLVED</code> - The finding was reviewed and remediated and is now considered resolved. </p> </li> </ul>"
|
||||
},
|
||||
"RecordState":{
|
||||
"shape":"StringFilterList",
|
||||
"documentation":"<p>The updated record state for the finding.</p>"
|
||||
|
|
@ -2468,7 +2567,7 @@
|
|||
"members":{
|
||||
"StandardsSubscriptionRequests":{
|
||||
"shape":"StandardsSubscriptionRequests",
|
||||
"documentation":"<p>The list of standards compliance checks to enable.</p> <important> <p>In this release, Security Hub supports only the CIS AWS Foundations standard.</p> <p>The ARN for the standard is <code>arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0</code>.</p> </important>"
|
||||
"documentation":"<p>The list of standards checks to enable.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2522,14 +2621,14 @@
|
|||
"members":{
|
||||
"Status":{
|
||||
"shape":"ComplianceStatus",
|
||||
"documentation":"<p>The result of a compliance check.</p>"
|
||||
"documentation":"<p>The result of a standards check.</p>"
|
||||
},
|
||||
"RelatedRequirements":{
|
||||
"shape":"RelatedRequirementsList",
|
||||
"documentation":"<p>List of requirements that are related to a standards control.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.</p> <p>Values include the following:</p> <ul> <li> <p>Allowed values are the following:</p> <ul> <li> <p> <code>PASSED</code> - Compliance check passed for all evaluated resources.</p> </li> <li> <p> <code>WARNING</code> - Some information is missing or this check is not supported given your configuration.</p> </li> <li> <p> <code>FAILED</code> - Compliance check failed for at least one evaluated resource.</p> </li> <li> <p> <code>NOT_AVAILABLE</code> - Check could not be performed due to a service outage, API error, or because the result of the AWS Config evaluation was <code>NOT_APPLICABLE</code>. If the AWS Config evaluation result was <code> NOT_APPLICABLE</code>, then after 3 days, Security Hub automatically archives the finding.</p> </li> </ul> </li> </ul>"
|
||||
"documentation":"<p>Exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS AWS Foundations. Contains security standard-related finding details.</p> <p>Values include the following:</p> <ul> <li> <p>Allowed values are the following:</p> <ul> <li> <p> <code>PASSED</code> - Standards check passed for all evaluated resources.</p> </li> <li> <p> <code>WARNING</code> - Some information is missing or this check is not supported given your configuration.</p> </li> <li> <p> <code>FAILED</code> - Standards check failed for at least one evaluated resource.</p> </li> <li> <p> <code>NOT_AVAILABLE</code> - Check could not be performed due to a service outage, API error, or because the result of the AWS Config evaluation was <code>NOT_APPLICABLE</code>. If the AWS Config evaluation result was <code> NOT_APPLICABLE</code>, then after 3 days, Security Hub automatically archives the finding.</p> </li> </ul> </li> </ul>"
|
||||
},
|
||||
"ComplianceStatus":{
|
||||
"type":"string",
|
||||
|
|
@ -2800,7 +2899,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that is required for pagination.</p>"
|
||||
"documentation":"<p>The token that is required for pagination. On your first call to the <code>DescribeActionTargets</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -2818,7 +2917,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that is required for pagination.</p>"
|
||||
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2851,7 +2950,7 @@
|
|||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that is required for pagination.</p>",
|
||||
"documentation":"<p>The token that is required for pagination. On your first call to the <code>DescribeProducts</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"NextToken"
|
||||
},
|
||||
|
|
@ -2873,7 +2972,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that is required for pagination.</p>"
|
||||
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2889,13 +2988,13 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>For requests to get the next page of results, the pagination token that was returned with the previous set of results. The initial request does not include a pagination token.</p>",
|
||||
"documentation":"<p>The token that is required for pagination. On your first call to the <code>DescribeStandardsControls</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"NextToken"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of compliance standard controls to return.</p>",
|
||||
"documentation":"<p>The maximum number of security standard controls to return.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxResults"
|
||||
}
|
||||
|
|
@ -2906,11 +3005,41 @@
|
|||
"members":{
|
||||
"Controls":{
|
||||
"shape":"StandardsControls",
|
||||
"documentation":"<p>A list of compliance standards controls.</p>"
|
||||
"documentation":"<p>A list of security standards controls.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>If there are more compliance standards control remaining in the results, then this is the pagination token to use to request the next page of compliance standard controls.</p>"
|
||||
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeStandardsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that is required for pagination. On your first call to the <code>DescribeStandards</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"NextToken"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of standards to return.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxResults"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeStandardsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Standards":{
|
||||
"shape":"Standards",
|
||||
"documentation":"<p>A list of available standards.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3013,7 +3142,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Paginates results. On your first call to the <code>GetEnabledStandards</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set <code>nextToken</code> in the request to the value of <code>nextToken</code> from the previous response.</p>"
|
||||
"documentation":"<p>The token that is required for pagination. On your first call to the <code>GetEnabledStandards</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -3030,7 +3159,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that is required for pagination.</p>"
|
||||
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3047,7 +3176,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Paginates results. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set <code>nextToken</code> in the request to the value of <code>nextToken</code> from the previous response.</p>"
|
||||
"documentation":"<p>The token that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -3065,7 +3194,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that is required for pagination.</p>"
|
||||
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3096,11 +3225,11 @@
|
|||
"members":{
|
||||
"InsightArns":{
|
||||
"shape":"ArnList",
|
||||
"documentation":"<p>The ARNs of the insights to describe.</p>"
|
||||
"documentation":"<p>The ARNs of the insights to describe. If you do not provide any insight ARNs, then <code>GetInsights</code> returns all of your custom insights. It does not return any managed insights.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Paginates results. On your first call to the <code>GetInsights</code> operation, set the value of this parameter to <code>NULL</code>. For subsequent calls to the operation, to continue listing data, set <code>nextToken</code> in the request to the value of <code>nextToken</code> from the previous response.</p>"
|
||||
"documentation":"<p>The token that is required for pagination. On your first call to the <code>GetInsights</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -3118,7 +3247,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that is required for pagination.</p>"
|
||||
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3278,6 +3407,17 @@
|
|||
"documentation":"<p>The insight results returned by the <code>GetInsightResults</code> operation.</p>"
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"IntegrationType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SEND_FINDINGS_TO_SECURITY_HUB",
|
||||
"RECEIVE_FINDINGS_FROM_SECURITY_HUB"
|
||||
]
|
||||
},
|
||||
"IntegrationTypeList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"IntegrationType"}
|
||||
},
|
||||
"InternalException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3395,7 +3535,7 @@
|
|||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Paginates results. On your first call to the <code>ListEnabledProductsForImport</code> operation, set the value of this parameter to <code>NULL</code>. For subsequent calls to the operation, to continue listing data, set <code>nextToken</code> in the request to the value of <code>NextToken</code> from the previous response.</p>",
|
||||
"documentation":"<p>The token that is required for pagination. On your first call to the <code>ListEnabledProductsForImport</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"NextToken"
|
||||
},
|
||||
|
|
@ -3416,7 +3556,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that is required for pagination.</p>"
|
||||
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3431,7 +3571,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Paginates results. On your first call to the <code>ListInvitations</code> operation, set the value of this parameter to <code>NULL</code>. For subsequent calls to the operation, to continue listing data, set <code>nextToken</code> in the request to the value of <code>NextToken</code> from the previous response. </p>",
|
||||
"documentation":"<p>The token that is required for pagination. On your first call to the <code>ListInvitations</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"NextToken"
|
||||
}
|
||||
|
|
@ -3446,7 +3586,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The token that is required for pagination.</p>"
|
||||
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3455,7 +3595,7 @@
|
|||
"members":{
|
||||
"OnlyAssociated":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Specifies which member accounts to include in the response based on their relationship status with the master account. The default value is <code>TRUE</code>.</p> <p>If <code>onlyAssociated</code> is set to <code>TRUE</code>, the response includes member accounts whose relationship status with the master is set to <code>ENABLED</code> or <code>DISABLED</code>.</p> <p>If <code>onlyAssociated</code> is set to <code>FALSE</code>, the response includes all existing member accounts. </p>",
|
||||
"documentation":"<p>Specifies which member accounts to include in the response based on their relationship status with the master account. The default value is <code>TRUE</code>.</p> <p>If <code>OnlyAssociated</code> is set to <code>TRUE</code>, the response includes member accounts whose relationship status with the master is set to <code>ENABLED</code> or <code>DISABLED</code>.</p> <p>If <code>OnlyAssociated</code> is set to <code>FALSE</code>, the response includes all existing member accounts. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"OnlyAssociated"
|
||||
},
|
||||
|
|
@ -3467,7 +3607,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Paginates results. On your first call to the <code>ListMembers</code> operation, set the value of this parameter to <code>NULL</code>. For subsequent calls to the operation, to continue listing data, set <code>nextToken</code> in the request to the value of <code>nextToken</code> from the previous response.</p>",
|
||||
"documentation":"<p>The token that is required for pagination. On your first call to the <code>ListMembers</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"NextToken"
|
||||
}
|
||||
|
|
@ -3482,7 +3622,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The token that is required for pagination.</p>"
|
||||
"documentation":"<p>The pagination token to use to request the next page of results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3832,6 +3972,10 @@
|
|||
"shape":"CategoryList",
|
||||
"documentation":"<p>The categories assigned to the product.</p>"
|
||||
},
|
||||
"IntegrationTypes":{
|
||||
"shape":"IntegrationTypeList",
|
||||
"documentation":"<p>The types of integration that the product supports. Available values are the following.</p> <ul> <li> <p> <code>SEND_FINDINGS_TO_SECURITY_HUB</code> - Indicates that the integration sends findings to Security Hub.</p> </li> <li> <p> <code>RECEIVE_FINDINGS_FROM_SECURITY_HUB</code> - Indicates that the integration receives findings from Security Hub.</p> </li> </ul>"
|
||||
},
|
||||
"MarketplaceUrl":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The URL for the page that contains more information about the product.</p>"
|
||||
|
|
@ -3995,6 +4139,10 @@
|
|||
"shape":"AwsS3BucketDetails",
|
||||
"documentation":"<p>Details about an Amazon S3 Bucket related to a finding.</p>"
|
||||
},
|
||||
"AwsS3Object":{
|
||||
"shape":"AwsS3ObjectDetails",
|
||||
"documentation":"<p>Details about an Amazon S3 object related to a finding.</p>"
|
||||
},
|
||||
"AwsIamAccessKey":{
|
||||
"shape":"AwsIamAccessKeyDetails",
|
||||
"documentation":"<p>Details about an IAM access key related to a finding.</p>"
|
||||
|
|
@ -4080,19 +4228,32 @@
|
|||
},
|
||||
"Severity":{
|
||||
"type":"structure",
|
||||
"required":["Normalized"],
|
||||
"members":{
|
||||
"Product":{
|
||||
"shape":"Double",
|
||||
"documentation":"<p>The native severity as defined by the AWS service or integrated partner product that generated the finding.</p>"
|
||||
},
|
||||
"Label":{
|
||||
"shape":"SeverityLabel",
|
||||
"documentation":"<p>The severity value of the finding. The allowed values are the following.</p> <ul> <li> <p> <code>INFORMATIONAL</code> - No issue was found.</p> </li> <li> <p> <code>LOW</code> - The issue does not require action on its own.</p> </li> <li> <p> <code>MEDIUM</code> - The issue must be addressed but not urgently.</p> </li> <li> <p> <code>HIGH</code> - The issue must be addressed as a priority.</p> </li> <li> <p> <code>CRITICAL</code> - The issue must be remediated immediately to avoid it escalating.</p> </li> </ul>"
|
||||
},
|
||||
"Normalized":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The normalized severity of a finding.</p>"
|
||||
"documentation":"<p>Deprecated. This attribute is being deprecated. Instead of providing <code>Normalized</code>, provide <code>Label</code>.</p> <p>If you provide <code>Normalized</code> and do not provide <code>Label</code>, <code>Label</code> is set automatically as follows. </p> <ul> <li> <p>0 - <code>INFORMATIONAL</code> </p> </li> <li> <p>1–39 - <code>LOW</code> </p> </li> <li> <p>40–69 - <code>MEDIUM</code> </p> </li> <li> <p>70–89 - <code>HIGH</code> </p> </li> <li> <p>90–100 - <code>CRITICAL</code> </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The severity of the finding.</p>"
|
||||
},
|
||||
"SeverityLabel":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"INFORMATIONAL",
|
||||
"LOW",
|
||||
"MEDIUM",
|
||||
"HIGH",
|
||||
"CRITICAL"
|
||||
]
|
||||
},
|
||||
"SeverityRating":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -4127,16 +4288,38 @@
|
|||
"desc"
|
||||
]
|
||||
},
|
||||
"Standard":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StandardsArn":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The ARN of a standard.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The name of the standard.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>A description of the standard.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides information about a specific standard.</p>"
|
||||
},
|
||||
"Standards":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Standard"}
|
||||
},
|
||||
"StandardsControl":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StandardsControlArn":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The ARN of the compliance standard control.</p>"
|
||||
"documentation":"<p>The ARN of the security standard control.</p>"
|
||||
},
|
||||
"ControlStatus":{
|
||||
"shape":"ControlStatus",
|
||||
"documentation":"<p>The current status of the compliance standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.</p>"
|
||||
"documentation":"<p>The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.</p>"
|
||||
},
|
||||
"DisabledReason":{
|
||||
"shape":"NonEmptyString",
|
||||
|
|
@ -4144,30 +4327,34 @@
|
|||
},
|
||||
"ControlStatusUpdatedAt":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time that the status of the compliance standard control was most recently updated.</p>"
|
||||
"documentation":"<p>The date and time that the status of the security standard control was most recently updated.</p>"
|
||||
},
|
||||
"ControlId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The identifier of the compliance standard control.</p>"
|
||||
"documentation":"<p>The identifier of the security standard control.</p>"
|
||||
},
|
||||
"Title":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The title of the compliance standard control.</p>"
|
||||
"documentation":"<p>The title of the security standard control.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The longer description of the compliance standard control. Provides information about what the control is checking for.</p>"
|
||||
"documentation":"<p>The longer description of the security standard control. Provides information about what the control is checking for.</p>"
|
||||
},
|
||||
"RemediationUrl":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>A link to remediation information for the control in the Security Hub user documentation</p>"
|
||||
"documentation":"<p>A link to remediation information for the control in the Security Hub user documentation.</p>"
|
||||
},
|
||||
"SeverityRating":{
|
||||
"shape":"SeverityRating",
|
||||
"documentation":"<p>The severity of findings generated from this compliance standard control.</p> <p>The finding severity is based on an assessment of how easy it would be to compromise AWS resources if the compliance issue is detected.</p>"
|
||||
"documentation":"<p>The severity of findings generated from this security standard control.</p> <p>The finding severity is based on an assessment of how easy it would be to compromise AWS resources if the issue is detected.</p>"
|
||||
},
|
||||
"RelatedRequirements":{
|
||||
"shape":"RelatedRequirementsList",
|
||||
"documentation":"<p>The list of requirements that are related to this control.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Details for an individual compliance standard control.</p>"
|
||||
"documentation":"<p>Details for an individual security standard control.</p>"
|
||||
},
|
||||
"StandardsControls":{
|
||||
"type":"list",
|
||||
|
|
@ -4203,7 +4390,7 @@
|
|||
},
|
||||
"StandardsArn":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The ARN of a standard.</p> <p>In this release, Security Hub supports only the CIS AWS Foundations standard, which uses the following ARN: <code>arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.</code> </p>"
|
||||
"documentation":"<p>The ARN of a standard.</p>"
|
||||
},
|
||||
"StandardsInput":{
|
||||
"shape":"StandardsInputParameterMap",
|
||||
|
|
@ -4228,7 +4415,7 @@
|
|||
"members":{
|
||||
"StandardsArn":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The ARN of the standard that you want to enable.</p> <important> <p>In this release, Security Hub only supports the CIS AWS Foundations standard. </p> <p>Its ARN is <code>arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0</code>.</p> </important>"
|
||||
"documentation":"<p>The ARN of the standard that you want to enable. To view the list of available standards and their ARNs, use the <code> <a>DescribeStandards</a> </code> operation.</p>"
|
||||
},
|
||||
"StandardsInput":{
|
||||
"shape":"StandardsInputParameterMap",
|
||||
|
|
@ -4501,17 +4688,17 @@
|
|||
"members":{
|
||||
"StandardsControlArn":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The ARN of the compliance standard control to enable or disable.</p>",
|
||||
"documentation":"<p>The ARN of the security standard control to enable or disable.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"StandardsControlArn"
|
||||
},
|
||||
"ControlStatus":{
|
||||
"shape":"ControlStatus",
|
||||
"documentation":"<p>The updated status of the compliance standard control.</p>"
|
||||
"documentation":"<p>The updated status of the security standard control.</p>"
|
||||
},
|
||||
"DisabledReason":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>A description of the reason why you are disabling a compliance standard control.</p>"
|
||||
"documentation":"<p>A description of the reason why you are disabling a security standard control.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4563,8 +4750,20 @@
|
|||
},
|
||||
"documentation":"<p>Details about an override action for a rule.</p>"
|
||||
},
|
||||
"Workflow":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Status":{
|
||||
"shape":"WorkflowStatus",
|
||||
"documentation":"<p>The status of the investigation into the finding. The allowed values are the following.</p> <ul> <li> <p> <code>NEW</code> - The initial state of a finding, before it is reviewed.</p> </li> <li> <p> <code>NOTIFIED</code> - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.</p> </li> <li> <p> <code>SUPPRESSED</code> - The finding will not be reviewed again and will not be acted upon.</p> </li> <li> <p> <code>RESOLVED</code> - The finding was reviewed and remediated and is now considered resolved. </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides information about the status of the investigation into a finding.</p>"
|
||||
},
|
||||
"WorkflowState":{
|
||||
"type":"string",
|
||||
"deprecated":true,
|
||||
"deprecatedMessage":"This field is deprecated, use Workflow.Status instead.",
|
||||
"enum":[
|
||||
"NEW",
|
||||
"ASSIGNED",
|
||||
|
|
@ -4572,7 +4771,16 @@
|
|||
"DEFERRED",
|
||||
"RESOLVED"
|
||||
]
|
||||
},
|
||||
"WorkflowStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NEW",
|
||||
"NOTIFIED",
|
||||
"RESOLVED",
|
||||
"SUPPRESSED"
|
||||
]
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the compliance status of your environment based on CIS AWS Foundations compliance checks. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the <i> <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html\">AWS Security Hub User Guide</a> </i>.</p> <p>When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to.</p> <p>For example, if your Region is set to <code>us-west-2</code>, when you use <code>CreateMembers</code> to add a member account to Security Hub, the association of the member account with the master account is created only in the <code>us-west-2</code> Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from.</p> <p>The following throttling limits apply to using Security Hub API operations.</p> <ul> <li> <p> <code>GetFindings</code> - <code>RateLimit</code> of 3 requests per second. <code>BurstLimit</code> of 6 requests per second.</p> </li> <li> <p> <code>UpdateFindings</code> - <code>RateLimit</code> of 1 request per second. <code>BurstLimit</code> of 5 requests per second.</p> </li> <li> <p>All other operations - <code>RateLimit</code> of 10 request per second. <code>BurstLimit</code> of 30 requests per second.</p> </li> </ul>"
|
||||
"documentation":"<p>Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the readiness status of your environment based on controls from supported security standards. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the <i> <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html\">AWS Security Hub User Guide</a> </i>.</p> <p>When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to.</p> <p>For example, if your Region is set to <code>us-west-2</code>, when you use <code> <a>CreateMembers</a> </code> to add a member account to Security Hub, the association of the member account with the master account is created only in the <code>us-west-2</code> Region. Security Hub must be enabled for the member account in the same Region that the invitation was sent from.</p> <p>The following throttling limits apply to using Security Hub API operations.</p> <ul> <li> <p> <code> <a>GetFindings</a> </code> - <code>RateLimit</code> of 3 requests per second. <code>BurstLimit</code> of 6 requests per second.</p> </li> <li> <p> <code> <a>UpdateFindings</a> </code> - <code>RateLimit</code> of 1 request per second. <code>BurstLimit</code> of 5 requests per second.</p> </li> <li> <p>All other operations - <code>RateLimit</code> of 10 requests per second. <code>BurstLimit</code> of 30 requests per second.</p> </li> </ul>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -388,6 +388,34 @@
|
|||
} ],
|
||||
"documentation" : "<p>Sets the permission policy for an application. For the list of actions supported for this operation, see\n <a href=\"https://docs.aws.amazon.com/serverlessrepo/latest/devguide/access-control-resource-based.html#application-permissions\">Application \n Permissions</a>\n .</p>"
|
||||
},
|
||||
"UnshareApplication" : {
|
||||
"name" : "UnshareApplication",
|
||||
"http" : {
|
||||
"method" : "POST",
|
||||
"requestUri" : "/applications/{applicationId}/unshare",
|
||||
"responseCode" : 204
|
||||
},
|
||||
"input" : {
|
||||
"shape" : "UnshareApplicationRequest"
|
||||
},
|
||||
"errors" : [ {
|
||||
"shape" : "NotFoundException",
|
||||
"documentation" : "<p>The resource (for example, an access policy statement) specified in the request doesn't exist.</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" : "InternalServerErrorException",
|
||||
"documentation" : "<p>The AWS Serverless Application Repository service encountered an internal error.</p>"
|
||||
}, {
|
||||
"shape" : "ForbiddenException",
|
||||
"documentation" : "<p>The client is not authenticated.</p>"
|
||||
} ],
|
||||
"documentation" : "<p>Unshares an application from an AWS Organization.</p><p>This operation can be called only from the organization's master account.</p>"
|
||||
},
|
||||
"UpdateApplication" : {
|
||||
"name" : "UpdateApplication",
|
||||
"http" : {
|
||||
|
|
@ -568,6 +596,11 @@
|
|||
"locationName" : "actions",
|
||||
"documentation" : "<p>For the list of actions supported for this operation, see <a href=\"https://docs.aws.amazon.com/serverlessrepo/latest/devguide/access-control-resource-based.html#application-permissions\">Application \n Permissions</a>.</p>"
|
||||
},
|
||||
"PrincipalOrgIDs" : {
|
||||
"shape" : "__listOf__string",
|
||||
"locationName" : "principalOrgIDs",
|
||||
"documentation" : "<p>An array of PrinciplalOrgIDs, which corresponds to AWS IAM <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#principal-org-id\">aws:PrincipalOrgID</a> global condition key.</p>"
|
||||
},
|
||||
"Principals" : {
|
||||
"shape" : "__listOf__string",
|
||||
"locationName" : "principals",
|
||||
|
|
@ -1879,6 +1912,35 @@
|
|||
"httpStatusCode" : 429
|
||||
}
|
||||
},
|
||||
"UnshareApplicationInput" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
"OrganizationId" : {
|
||||
"shape" : "__string",
|
||||
"locationName" : "organizationId",
|
||||
"documentation" : "<p>The AWS Organization ID to unshare the application from.</p>"
|
||||
}
|
||||
},
|
||||
"required" : [ "OrganizationId" ],
|
||||
"documentation":"<p>Unshare application request.</p>"
|
||||
},
|
||||
"UnshareApplicationRequest" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
"ApplicationId" : {
|
||||
"shape" : "__string",
|
||||
"location" : "uri",
|
||||
"locationName" : "applicationId",
|
||||
"documentation" : "<p>The Amazon Resource Name (ARN) of the application.</p>"
|
||||
},
|
||||
"OrganizationId" : {
|
||||
"shape" : "__string",
|
||||
"locationName" : "organizationId",
|
||||
"documentation" : "<p>The AWS Organization ID to unshare the application from.</p>"
|
||||
}
|
||||
},
|
||||
"required" : [ "ApplicationId", "OrganizationId" ]
|
||||
},
|
||||
"UpdateApplicationInput" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
|
|
|
|||
|
|
@ -574,7 +574,8 @@
|
|||
"errors":[
|
||||
{"shape":"InvalidParametersException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
],
|
||||
"documentation":"<p>Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.</p>"
|
||||
},
|
||||
"DescribeTagOption":{
|
||||
"name":"DescribeTagOption",
|
||||
|
|
@ -813,7 +814,8 @@
|
|||
"input":{"shape":"ListPortfolioAccessInput"},
|
||||
"output":{"shape":"ListPortfolioAccessOutput"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidParametersException"}
|
||||
],
|
||||
"documentation":"<p>Lists the account IDs that have access to the specified portfolio.</p>"
|
||||
},
|
||||
|
|
@ -1522,6 +1524,14 @@
|
|||
"Owner":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The owner of the constraint.</p>"
|
||||
},
|
||||
"ProductId":{
|
||||
"shape":"Id",
|
||||
"documentation":"<p>The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.</p>"
|
||||
},
|
||||
"PortfolioId":{
|
||||
"shape":"Id",
|
||||
"documentation":"<p>The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a constraint.</p>"
|
||||
|
|
@ -1978,7 +1988,7 @@
|
|||
},
|
||||
"Definition":{
|
||||
"shape":"ServiceActionDefinitionMap",
|
||||
"documentation":"<p>The self-service action definition. Can be one of the following:</p> <dl> <dt>Name</dt> <dd> <p>The name of the AWS Systems Manager Document. For example, <code>AWS-RestartEC2Instance</code>.</p> </dd> <dt>Version</dt> <dd> <p>The AWS Systems Manager automation document version. For example, <code>\"Version\": \"1\"</code> </p> </dd> <dt>AssumeRole</dt> <dd> <p>The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, <code>\"AssumeRole\": \"arn:aws:iam::12345678910:role/ActionRole\"</code>.</p> <p>To reuse the provisioned product launch role, set to <code>\"AssumeRole\": \"LAUNCH_ROLE\"</code>.</p> </dd> <dt>Parameters</dt> <dd> <p>The list of parameters in JSON format.</p> <p>For example: <code>[{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TARGET\\\"}]</code>.</p> </dd> </dl>"
|
||||
"documentation":"<p>The self-service action definition. Can be one of the following:</p> <dl> <dt>Name</dt> <dd> <p>The name of the AWS Systems Manager Document. For example, <code>AWS-RestartEC2Instance</code>.</p> </dd> <dt>Version</dt> <dd> <p>The AWS Systems Manager automation document version. For example, <code>\"Version\": \"1\"</code> </p> </dd> <dt>AssumeRole</dt> <dd> <p>The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, <code>\"AssumeRole\": \"arn:aws:iam::12345678910:role/ActionRole\"</code>.</p> <p>To reuse the provisioned product launch role, set to <code>\"AssumeRole\": \"LAUNCH_ROLE\"</code>.</p> </dd> <dt>Parameters</dt> <dd> <p>The list of parameters in JSON format.</p> <p>For example: <code>[{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TARGET\\\"}]</code> or <code>[{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TEXT_VALUE\\\"}]</code>.</p> </dd> </dl>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"ServiceActionDescription",
|
||||
|
|
@ -2637,15 +2647,27 @@
|
|||
"ServiceActionId"
|
||||
],
|
||||
"members":{
|
||||
"ProvisionedProductId":{"shape":"Id"},
|
||||
"ServiceActionId":{"shape":"Id"},
|
||||
"AcceptLanguage":{"shape":"AcceptLanguage"}
|
||||
"ProvisionedProductId":{
|
||||
"shape":"Id",
|
||||
"documentation":"<p>The identifier of the provisioned product.</p>"
|
||||
},
|
||||
"ServiceActionId":{
|
||||
"shape":"Id",
|
||||
"documentation":"<p>The self-service action identifier.</p>"
|
||||
},
|
||||
"AcceptLanguage":{
|
||||
"shape":"AcceptLanguage",
|
||||
"documentation":"<p>The language code.</p> <ul> <li> <p> <code>en</code> - English (default)</p> </li> <li> <p> <code>jp</code> - Japanese</p> </li> <li> <p> <code>zh</code> - Chinese</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeServiceActionExecutionParametersOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ServiceActionParameters":{"shape":"ExecutionParameters"}
|
||||
"ServiceActionParameters":{
|
||||
"shape":"ExecutionParameters",
|
||||
"documentation":"<p>The parameters of the self-service action.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeServiceActionInput":{
|
||||
|
|
@ -2912,7 +2934,10 @@
|
|||
"shape":"AcceptLanguage",
|
||||
"documentation":"<p>The language code.</p> <ul> <li> <p> <code>en</code> - English (default)</p> </li> <li> <p> <code>jp</code> - Japanese</p> </li> <li> <p> <code>zh</code> - Chinese</p> </li> </ul>"
|
||||
},
|
||||
"Parameters":{"shape":"ExecutionParameterMap"}
|
||||
"Parameters":{
|
||||
"shape":"ExecutionParameterMap",
|
||||
"documentation":"<p>A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as <code>TARGET</code>, the provided value will override the default value generated by AWS Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for any special parameters such as <code>TARGET</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ExecuteProvisionedProductServiceActionOutput":{
|
||||
|
|
@ -2927,10 +2952,20 @@
|
|||
"ExecutionParameter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{"shape":"ExecutionParameterKey"},
|
||||
"Type":{"shape":"ExecutionParameterType"},
|
||||
"DefaultValues":{"shape":"ExecutionParameterValueList"}
|
||||
}
|
||||
"Name":{
|
||||
"shape":"ExecutionParameterKey",
|
||||
"documentation":"<p>The name of the execution parameter.</p>"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"ExecutionParameterType",
|
||||
"documentation":"<p>The execution parameter type.</p>"
|
||||
},
|
||||
"DefaultValues":{
|
||||
"shape":"ExecutionParameterValueList",
|
||||
"documentation":"<p>The default values for the execution parameter.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Details of an execution parameter value that is passed to a self-service action when executed on a provisioned product.</p>"
|
||||
},
|
||||
"ExecutionParameterKey":{
|
||||
"type":"string",
|
||||
|
|
@ -3269,6 +3304,18 @@
|
|||
"PortfolioId":{
|
||||
"shape":"Id",
|
||||
"documentation":"<p>The portfolio identifier.</p>"
|
||||
},
|
||||
"OrganizationParentId":{
|
||||
"shape":"Id",
|
||||
"documentation":"<p>The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.</p>"
|
||||
},
|
||||
"PageToken":{
|
||||
"shape":"PageToken",
|
||||
"documentation":"<p>The page token for the next set of results. To retrieve the first set of results, use null.</p>"
|
||||
},
|
||||
"PageSize":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum number of items to return with this call.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -5924,7 +5971,7 @@
|
|||
},
|
||||
"Active":{
|
||||
"shape":"ProvisioningArtifactActive",
|
||||
"documentation":"<p>Indicates whether the product version is active.</p>"
|
||||
"documentation":"<p>Indicates whether the product version is active.</p> <p>Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.</p>"
|
||||
},
|
||||
"Guidance":{
|
||||
"shape":"ProvisioningArtifactGuidance",
|
||||
|
|
|
|||
|
|
@ -51,6 +51,23 @@
|
|||
],
|
||||
"documentation":"<p>Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.</p> <p>You can associate only one <code>RoleArn</code> with your subscription. If you submit an <code>AssociateDRTRole</code> request for an account that already has an associated role, the new <code>RoleArn</code> will replace the existing <code>RoleArn</code>. </p> <p>Prior to making the <code>AssociateDRTRole</code> request, you must attach the <a href=\"https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSShieldDRTAccessPolicy\">AWSShieldDRTAccessPolicy</a> managed policy to the role you will specify in the request. For more information see <a href=\" https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html\">Attaching and Detaching IAM Policies</a>. The role must also trust the service principal <code> drt.shield.amazonaws.com</code>. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html\">IAM JSON Policy Elements: Principal</a>.</p> <p>The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you.</p> <p>You must have the <code>iam:PassRole</code> permission to make an <code>AssociateDRTRole</code> request. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html\">Granting a User Permissions to Pass a Role to an AWS Service</a>. </p> <p>To use the services of the DRT and make an <code>AssociateDRTRole</code> request, you must be subscribed to the <a href=\"https://aws.amazon.com/premiumsupport/business-support/\">Business Support plan</a> or the <a href=\"https://aws.amazon.com/premiumsupport/enterprise-support/\">Enterprise Support plan</a>.</p>"
|
||||
},
|
||||
"AssociateHealthCheck":{
|
||||
"name":"AssociateHealthCheck",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"AssociateHealthCheckRequest"},
|
||||
"output":{"shape":"AssociateHealthCheckResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"LimitsExceededException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"OptimisticLockException"}
|
||||
],
|
||||
"documentation":"<p>Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation. </p> <p>You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option\">Shield Advanced Health-Based Detection</a> in the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF and AWS Shield Developer Guide</a>. </p>"
|
||||
},
|
||||
"CreateProtection":{
|
||||
"name":"CreateProtection",
|
||||
"http":{
|
||||
|
|
@ -220,6 +237,22 @@
|
|||
],
|
||||
"documentation":"<p>Removes the DDoS Response team's (DRT) access to your AWS account.</p> <p>To make a <code>DisassociateDRTRole</code> request, you must be subscribed to the <a href=\"https://aws.amazon.com/premiumsupport/business-support/\">Business Support plan</a> or the <a href=\"https://aws.amazon.com/premiumsupport/enterprise-support/\">Enterprise Support plan</a>. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a <code>DisassociateDRTRole</code> request to remove this access.</p>"
|
||||
},
|
||||
"DisassociateHealthCheck":{
|
||||
"name":"DisassociateHealthCheck",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DisassociateHealthCheckRequest"},
|
||||
"output":{"shape":"DisassociateHealthCheckResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"OptimisticLockException"}
|
||||
],
|
||||
"documentation":"<p>Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation. </p> <p>You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/ddos-overview.html#ddos-advanced-health-check-option\">Shield Advanced Health-Based Detection</a> in the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/\">AWS WAF and AWS Shield Developer Guide</a>. </p>"
|
||||
},
|
||||
"GetSubscriptionState":{
|
||||
"name":"GetSubscriptionState",
|
||||
"http":{
|
||||
|
|
@ -311,7 +344,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"errorMessage"}
|
||||
},
|
||||
"documentation":"<p>In order to grant the necessary access to the DDoS Response Team, the user submitting <code>AssociateDRTRole</code> must have the <code>iam:PassRole</code> permission. This error indicates the user did not have the appropriate permissions. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html\">Granting a User Permissions to Pass a Role to an AWS Service</a>. </p>",
|
||||
"documentation":"<p>In order to grant the necessary access to the DDoS Response Team, the user submitting the request must have the <code>iam:PassRole</code> permission. This error indicates the user did not have the appropriate permissions. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html\">Granting a User Permissions to Pass a Role to an AWS Service</a>. </p>",
|
||||
"exception":true
|
||||
},
|
||||
"AssociateDRTLogBucketRequest":{
|
||||
|
|
@ -344,6 +377,28 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"AssociateHealthCheckRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ProtectionId",
|
||||
"HealthCheckArn"
|
||||
],
|
||||
"members":{
|
||||
"ProtectionId":{
|
||||
"shape":"ProtectionId",
|
||||
"documentation":"<p>The unique identifier (ID) for the <a>Protection</a> object to add the health check association to. </p>"
|
||||
},
|
||||
"HealthCheckArn":{
|
||||
"shape":"HealthCheckArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the health check to associate with the protection.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AssociateHealthCheckResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"AttackDetail":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -680,6 +735,28 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"DisassociateHealthCheckRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ProtectionId",
|
||||
"HealthCheckArn"
|
||||
],
|
||||
"members":{
|
||||
"ProtectionId":{
|
||||
"shape":"ProtectionId",
|
||||
"documentation":"<p>The unique identifier (ID) for the <a>Protection</a> object to remove the health check association from. </p>"
|
||||
},
|
||||
"HealthCheckArn":{
|
||||
"shape":"HealthCheckArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the health check that is associated with the protection.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DisassociateHealthCheckResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"Double":{"type":"double"},
|
||||
"DurationInSeconds":{
|
||||
"type":"long",
|
||||
|
|
@ -723,6 +800,17 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"HealthCheckArn":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
"min":1,
|
||||
"pattern":"^arn:aws:route53:::healthcheck/\\S{36}$"
|
||||
},
|
||||
"HealthCheckId":{"type":"string"},
|
||||
"HealthCheckIds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"HealthCheckId"}
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"InternalErrorException":{
|
||||
"type":"structure",
|
||||
|
|
@ -930,6 +1018,10 @@
|
|||
"ResourceArn":{
|
||||
"shape":"ResourceArn",
|
||||
"documentation":"<p>The ARN (Amazon Resource Name) of the AWS resource that is protected.</p>"
|
||||
},
|
||||
"HealthCheckIds":{
|
||||
"shape":"HealthCheckIds",
|
||||
"documentation":"<p>The unique identifier (ID) for the Route 53 health check that's associated with the protection. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An object that represents a resource that is under DDoS protection.</p>"
|
||||
|
|
|
|||
|
|
@ -183,7 +183,7 @@
|
|||
{"shape":"BadRequestException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Adds one or more tags to a signing profile. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the signing profile using its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.</p>"
|
||||
"documentation":"<p>Adds one or more tags to a signing profile. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. To specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a key-value pair.</p>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
|
|
@ -198,7 +198,7 @@
|
|||
{"shape":"BadRequestException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Remove one or more tags from a signing profile. Specify a list of tag keys to remove the tags.</p>"
|
||||
"documentation":"<p>Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -267,7 +267,7 @@
|
|||
},
|
||||
"signingMaterial":{
|
||||
"shape":"SigningMaterial",
|
||||
"documentation":"<p>Amazon Resource Name (ARN) of your code signing certificate.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of your code signing certificate.</p>"
|
||||
},
|
||||
"platformId":{
|
||||
"shape":"PlatformId",
|
||||
|
|
@ -481,7 +481,11 @@
|
|||
},
|
||||
"ImageFormat":{
|
||||
"type":"string",
|
||||
"enum":["JSON"]
|
||||
"enum":[
|
||||
"JSON",
|
||||
"JSONEmbedded",
|
||||
"JSONDetached"
|
||||
]
|
||||
},
|
||||
"ImageFormats":{
|
||||
"type":"list",
|
||||
|
|
@ -672,7 +676,7 @@
|
|||
"Prefix":{"type":"string"},
|
||||
"ProfileName":{
|
||||
"type":"string",
|
||||
"max":20,
|
||||
"max":64,
|
||||
"min":2,
|
||||
"pattern":"^[a-zA-Z0-9_]{2,}"
|
||||
},
|
||||
|
|
@ -696,7 +700,7 @@
|
|||
},
|
||||
"platformId":{
|
||||
"shape":"PlatformId",
|
||||
"documentation":"<p>The ID of the signing profile to be created.</p>"
|
||||
"documentation":"<p>The ID of the signing platform to be created.</p>"
|
||||
},
|
||||
"overrides":{
|
||||
"shape":"SigningPlatformOverrides",
|
||||
|
|
@ -708,7 +712,7 @@
|
|||
},
|
||||
"tags":{
|
||||
"shape":"TagMap",
|
||||
"documentation":"<p>Tags to be associated with the signing profile being created.</p>"
|
||||
"documentation":"<p>Tags to be associated with the signing profile that is being created.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -805,7 +809,7 @@
|
|||
},
|
||||
"hashAlgorithmOptions":{
|
||||
"shape":"HashAlgorithmOptions",
|
||||
"documentation":"<p>The hash algorithm options that are available for a a code signing job.</p>"
|
||||
"documentation":"<p>The hash algorithm options that are available for a code signing job.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration of a code signing operation.</p>"
|
||||
|
|
@ -833,11 +837,11 @@
|
|||
"members":{
|
||||
"supportedFormats":{
|
||||
"shape":"ImageFormats",
|
||||
"documentation":"<p>The supported formats of a code signing signing image.</p>"
|
||||
"documentation":"<p>The supported formats of a code signing image.</p>"
|
||||
},
|
||||
"defaultFormat":{
|
||||
"shape":"ImageFormat",
|
||||
"documentation":"<p>The default format of a code signing signing image.</p>"
|
||||
"documentation":"<p>The default format of a code signing image.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The image format of a code signing platform or profile.</p>"
|
||||
|
|
@ -927,7 +931,7 @@
|
|||
"documentation":"<p>The maximum size (in MB) of code that can be signed by a code signing platform.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about the signing configurations and parameters that is used to perform a code signing job.</p>"
|
||||
"documentation":"<p>Contains information about the signing configurations and parameters that are used to perform a code signing job.</p>"
|
||||
},
|
||||
"SigningPlatformOverrides":{
|
||||
"type":"structure",
|
||||
|
|
@ -935,6 +939,10 @@
|
|||
"signingConfiguration":{
|
||||
"shape":"SigningConfigurationOverrides",
|
||||
"documentation":"<p>A signing configuration that overrides the default encryption or hash algorithm of a signing job.</p>"
|
||||
},
|
||||
"signingImageFormat":{
|
||||
"shape":"ImageFormat",
|
||||
"documentation":"<p>A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, <code>JSONEmbedded</code> or <code>JSONDetached</code>. (A third format value, <code>JSON</code>, is reserved for future use.) With <code>JSONEmbedded</code>, the signing image has the payload embedded in it. With <code>JSONDetached</code>, the payload is not be embedded in the signing image.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Any overrides that are applied to the signing configuration of a code signing platform.</p>"
|
||||
|
|
@ -968,7 +976,7 @@
|
|||
},
|
||||
"arn":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Amazon Resource Name (ARN) for the signing profile.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the signing profile.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagMap",
|
||||
|
|
@ -1072,7 +1080,7 @@
|
|||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Amazon Resource Name (ARN) for the signing profile.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the signing profile.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
},
|
||||
|
|
@ -1109,13 +1117,13 @@
|
|||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Amazon Resource Name (ARN) for the signing profile .</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the signing profile.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
},
|
||||
"tagKeys":{
|
||||
"shape":"TagKeyList",
|
||||
"documentation":"<p>A list of tag keys to be removed from the signing profile .</p>",
|
||||
"documentation":"<p>A list of tag keys to be removed from the signing profile.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"tagKeys"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -464,7 +464,7 @@
|
|||
},
|
||||
"SnowballType":{
|
||||
"shape":"SnowballType",
|
||||
"documentation":"<p>The type of AWS Snowball device to use for this cluster. Currently, the only supported device type for cluster jobs is <code>EDGE</code>.</p>"
|
||||
"documentation":"<p>The type of AWS Snowball device to use for this cluster. Currently, the only supported device type for cluster jobs is <code>EDGE</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html\">Snowball Edge Device Options</a> in the Snowball Edge Developer Guide.</p>"
|
||||
},
|
||||
"CreationDate":{
|
||||
"shape":"Timestamp",
|
||||
|
|
@ -489,6 +489,10 @@
|
|||
"ForwardingAddressId":{
|
||||
"shape":"AddressId",
|
||||
"documentation":"<p>The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.</p>"
|
||||
},
|
||||
"TaxDocuments":{
|
||||
"shape":"TaxDocuments",
|
||||
"documentation":"<p>The tax documents required in your AWS Region.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains metadata about a specific cluster.</p>"
|
||||
|
|
@ -576,7 +580,7 @@
|
|||
},
|
||||
"SnowballType":{
|
||||
"shape":"SnowballType",
|
||||
"documentation":"<p>The type of AWS Snowball device to use for this cluster. Currently, the only supported device type for cluster jobs is <code>EDGE</code>.</p>"
|
||||
"documentation":"<p>The type of AWS Snowball device to use for this cluster. Currently, the only supported device type for cluster jobs is <code>EDGE</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html\">Snowball Edge Device Options</a> in the Snowball Edge Developer Guide.</p>"
|
||||
},
|
||||
"ShippingOption":{
|
||||
"shape":"ShippingOption",
|
||||
|
|
@ -589,6 +593,10 @@
|
|||
"ForwardingAddressId":{
|
||||
"shape":"AddressId",
|
||||
"documentation":"<p>The forwarding address ID for a cluster. This field is not supported in most regions.</p>"
|
||||
},
|
||||
"TaxDocuments":{
|
||||
"shape":"TaxDocuments",
|
||||
"documentation":"<p>The tax documents required in your AWS Region.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -646,11 +654,15 @@
|
|||
},
|
||||
"SnowballType":{
|
||||
"shape":"SnowballType",
|
||||
"documentation":"<p>The type of AWS Snowball device to use for this job. Currently, the only supported device type for cluster jobs is <code>EDGE</code>.</p>"
|
||||
"documentation":"<p>The type of AWS Snowball device to use for this job. Currently, the only supported device type for cluster jobs is <code>EDGE</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html\">Snowball Edge Device Options</a> in the Snowball Edge Developer Guide.</p>"
|
||||
},
|
||||
"ForwardingAddressId":{
|
||||
"shape":"AddressId",
|
||||
"documentation":"<p>The forwarding address ID for a job. This field is not supported in most regions.</p>"
|
||||
},
|
||||
"TaxDocuments":{
|
||||
"shape":"TaxDocuments",
|
||||
"documentation":"<p>The tax documents required in your AWS Region.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -813,6 +825,10 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"EventTriggerDefinition"}
|
||||
},
|
||||
"GSTIN":{
|
||||
"type":"string",
|
||||
"pattern":"\\d{2}[A-Z]{5}\\d{4}[A-Z]{1}[A-Z\\d]{1}[Z]{1}[A-Z\\d]{1}"
|
||||
},
|
||||
"GetJobManifestRequest":{
|
||||
"type":"structure",
|
||||
"required":["JobId"],
|
||||
|
|
@ -888,6 +904,16 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"INDTaxDocuments":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GSTIN":{
|
||||
"shape":"GSTIN",
|
||||
"documentation":"<p>The Goods and Services Tax (GST) documents required in AWS Regions in India.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The tax documents required in AWS Regions in India.</p>"
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"InvalidAddressException":{
|
||||
"type":"structure",
|
||||
|
|
@ -1065,6 +1091,10 @@
|
|||
"ForwardingAddressId":{
|
||||
"shape":"AddressId",
|
||||
"documentation":"<p>The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.</p>"
|
||||
},
|
||||
"TaxDocuments":{
|
||||
"shape":"TaxDocuments",
|
||||
"documentation":"<p>The metadata associated with the tax documents required in your AWS Region.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the <code>DescribeJob</code> action.</p>"
|
||||
|
|
@ -1395,6 +1425,16 @@
|
|||
"type":"string",
|
||||
"min":1
|
||||
},
|
||||
"TaxDocuments":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"IND":{
|
||||
"shape":"INDTaxDocuments",
|
||||
"documentation":"<p>The tax documents required in AWS Regions in India.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The tax documents required in your AWS Region.</p>"
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"UnsupportedAddressException":{
|
||||
"type":"structure",
|
||||
|
|
|
|||
|
|
@ -5533,7 +5533,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
"documentation":"<p>The token to use when requesting the next set of items.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -11300,8 +11300,8 @@
|
|||
"box":true
|
||||
},
|
||||
"ApproveUntilDate":{
|
||||
"shape":"PatchStringDate",
|
||||
"documentation":"<p>The cutoff date for auto approval of released patches. Any patches released on or before this date will be installed automatically</p>",
|
||||
"shape":"PatchStringDateTime",
|
||||
"documentation":"<p>Example API</p>",
|
||||
"box":true
|
||||
},
|
||||
"EnableNonSecurity":{
|
||||
|
|
@ -11405,11 +11405,10 @@
|
|||
},
|
||||
"documentation":"<p>Information about the approval status of a patch.</p>"
|
||||
},
|
||||
"PatchStringDate":{
|
||||
"PatchStringDateTime":{
|
||||
"type":"string",
|
||||
"max":10,
|
||||
"min":1,
|
||||
"pattern":"^(\\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))$"
|
||||
"min":1
|
||||
},
|
||||
"PatchTitle":{"type":"string"},
|
||||
"PatchUnreportedNotApplicableCount":{"type":"integer"},
|
||||
|
|
@ -11969,6 +11968,21 @@
|
|||
"exception":true
|
||||
},
|
||||
"ResourceDataSyncCreatedTime":{"type":"timestamp"},
|
||||
"ResourceDataSyncDestinationDataSharing":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DestinationDataSharingType":{
|
||||
"shape":"ResourceDataSyncDestinationDataSharingType",
|
||||
"documentation":"<p>The sharing data type. Only <code>Organization</code> is supported.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Synchronize Systems Manager Inventory data from multiple AWS accounts defined in AWS Organizations to a centralized Amazon S3 bucket. Data is synchronized to individual key prefixes in the central bucket. Each key prefix represents a different AWS account ID.</p>"
|
||||
},
|
||||
"ResourceDataSyncDestinationDataSharingType":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1
|
||||
},
|
||||
"ResourceDataSyncIncludeFutureRegions":{"type":"boolean"},
|
||||
"ResourceDataSyncInvalidConfigurationException":{
|
||||
"type":"structure",
|
||||
|
|
@ -12103,6 +12117,10 @@
|
|||
"AWSKMSKeyARN":{
|
||||
"shape":"ResourceDataSyncAWSKMSKeyARN",
|
||||
"documentation":"<p>The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination Amazon S3 bucket.</p>"
|
||||
},
|
||||
"DestinationDataSharing":{
|
||||
"shape":"ResourceDataSyncDestinationDataSharing",
|
||||
"documentation":"<p>Enables destination data sharing. By default, this field is <code>null</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the target Amazon S3 bucket for the Resource Data Sync.</p>"
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@
|
|||
{"shape":"StateMachineTypeNotSupported"},
|
||||
{"shape":"TooManyTags"}
|
||||
],
|
||||
"documentation":"<p>Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency check is based on the state machine <code>name</code> and <code>definition</code>. If a following request has a different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and <code>tags</code> will not be updated, even if they are different.</p> </note>",
|
||||
"documentation":"<p>Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html\">Amazon States Language</a> in the AWS Step Functions User Guide.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency check is based on the state machine <code>name</code>, <code>definition</code>, <code>type</code>, and <code>LoggingConfiguration</code>. If a following request has a different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and <code>tags</code> will not be updated, even if they are different.</p> </note>",
|
||||
"idempotent":true
|
||||
},
|
||||
"DeleteActivity":{
|
||||
|
|
@ -75,7 +75,7 @@
|
|||
"errors":[
|
||||
{"shape":"InvalidArn"}
|
||||
],
|
||||
"documentation":"<p>Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to <code>DELETING</code> and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition.</p> <note> <p>The state machine itself is deleted after all executions are completed or deleted.</p> </note>"
|
||||
"documentation":"<p>Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to <code>DELETING</code> and begins the deletion process. </p> <note> <p>For <code>EXPRESS</code>state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code> API is called.</p> </note>"
|
||||
},
|
||||
"DescribeActivity":{
|
||||
"name":"DescribeActivity",
|
||||
|
|
@ -103,7 +103,7 @@
|
|||
{"shape":"ExecutionDoesNotExist"},
|
||||
{"shape":"InvalidArn"}
|
||||
],
|
||||
"documentation":"<p>Describes an execution.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>"
|
||||
"documentation":"<p>Describes an execution.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>"
|
||||
},
|
||||
"DescribeStateMachine":{
|
||||
"name":"DescribeStateMachine",
|
||||
|
|
@ -131,7 +131,7 @@
|
|||
{"shape":"ExecutionDoesNotExist"},
|
||||
{"shape":"InvalidArn"}
|
||||
],
|
||||
"documentation":"<p>Describes the state machine associated with a specific execution.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>"
|
||||
"documentation":"<p>Describes the state machine associated with a specific execution.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>"
|
||||
},
|
||||
"GetActivityTask":{
|
||||
"name":"GetActivityTask",
|
||||
|
|
@ -161,7 +161,7 @@
|
|||
{"shape":"InvalidArn"},
|
||||
{"shape":"InvalidToken"}
|
||||
],
|
||||
"documentation":"<p>Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the <code>timeStamp</code> of the events. Use the <code>reverseOrder</code> parameter to get the latest events first.</p> <p>If <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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p>"
|
||||
"documentation":"<p>Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the <code>timeStamp</code> of the events. Use the <code>reverseOrder</code> parameter to get the latest events first.</p> <p>If <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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>"
|
||||
},
|
||||
"ListActivities":{
|
||||
"name":"ListActivities",
|
||||
|
|
@ -190,7 +190,7 @@
|
|||
{"shape":"StateMachineDoesNotExist"},
|
||||
{"shape":"StateMachineTypeNotSupported"}
|
||||
],
|
||||
"documentation":"<p>Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.</p> <p>If <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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>"
|
||||
"documentation":"<p>Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.</p> <p>If <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. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>"
|
||||
},
|
||||
"ListStateMachines":{
|
||||
"name":"ListStateMachines",
|
||||
|
|
@ -297,7 +297,7 @@
|
|||
{"shape":"ExecutionDoesNotExist"},
|
||||
{"shape":"InvalidArn"}
|
||||
],
|
||||
"documentation":"<p>Stops an execution.</p>"
|
||||
"documentation":"<p>Stops an execution.</p> <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
|
|
@ -344,7 +344,7 @@
|
|||
{"shape":"StateMachineDeleting"},
|
||||
{"shape":"StateMachineDoesNotExist"}
|
||||
],
|
||||
"documentation":"<p>Updates an existing state machine by modifying its <code>definition</code> and/or <code>roleArn</code>. Running executions will continue to use the previous <code>definition</code> and <code>roleArn</code>. You must include at least one of <code>definition</code> or <code>roleArn</code> or you will receive a <code>MissingRequiredParameter</code> error.</p> <note> <p>All <code>StartExecution</code> calls within a few seconds will use the updated <code>definition</code> and <code>roleArn</code>. Executions started immediately after calling <code>UpdateStateMachine</code> may use the previous state machine <code>definition</code> and <code>roleArn</code>. </p> </note>",
|
||||
"documentation":"<p>Updates an existing state machine by modifying its <code>definition</code>, <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue to use the previous <code>definition</code> and <code>roleArn</code>. You must include at least one of <code>definition</code> or <code>roleArn</code> or you will receive a <code>MissingRequiredParameter</code> error.</p> <note> <p>All <code>StartExecution</code> calls within a few seconds will use the updated <code>definition</code> and <code>roleArn</code>. Executions started immediately after calling <code>UpdateStateMachine</code> may use the previous state machine <code>definition</code> and <code>roleArn</code>. </p> </note>",
|
||||
"idempotent":true
|
||||
}
|
||||
},
|
||||
|
|
@ -397,7 +397,7 @@
|
|||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the activity.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the activity.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
|
||||
},
|
||||
"creationDate":{
|
||||
"shape":"Timestamp",
|
||||
|
|
@ -514,7 +514,7 @@
|
|||
"members":{
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions\"> Limits Related to State Machine Executions</a> in the <i>AWS Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions\"> Limits Related to State Machine Executions</a> in the <i>AWS Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -549,7 +549,7 @@
|
|||
"members":{
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the state machine. </p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the state machine. </p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
|
||||
},
|
||||
"definition":{
|
||||
"shape":"Definition",
|
||||
|
|
@ -561,11 +561,11 @@
|
|||
},
|
||||
"type":{
|
||||
"shape":"StateMachineType",
|
||||
"documentation":"<p>Determines whether a Standard or Express state machine is created. If not set, Standard is created.</p>"
|
||||
"documentation":"<p>Determines whether a Standard or Express state machine is created. The default is <code>STANDARD</code>. You cannot update the <code>type</code> of a state machine once it has been created.</p>"
|
||||
},
|
||||
"loggingConfiguration":{
|
||||
"shape":"LoggingConfiguration",
|
||||
"documentation":"<p>Defines what execution history events are logged and where they are logged.</p>"
|
||||
"documentation":"<p>Defines what execution history events are logged and where they are logged.</p> <note> <p>By default, the <code>level</code> is set to <code>OFF</code>. For more information see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html\">Log Levels</a> in the AWS Step Functions User Guide.</p> </note>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -650,7 +650,7 @@
|
|||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the activity.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the activity.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
|
||||
},
|
||||
"creationDate":{
|
||||
"shape":"Timestamp",
|
||||
|
|
@ -680,7 +680,7 @@
|
|||
"members":{
|
||||
"executionArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the execution.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that id entifies the execution.</p>"
|
||||
},
|
||||
"stateMachineArn":{
|
||||
"shape":"Arn",
|
||||
|
|
@ -688,7 +688,7 @@
|
|||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"ExecutionStatus",
|
||||
|
|
@ -751,7 +751,8 @@
|
|||
"updateDate":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.</p>"
|
||||
}
|
||||
},
|
||||
"loggingConfiguration":{"shape":"LoggingConfiguration"}
|
||||
}
|
||||
},
|
||||
"DescribeStateMachineInput":{
|
||||
|
|
@ -781,7 +782,7 @@
|
|||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the state machine.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the state machine.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"StateMachineStatus",
|
||||
|
|
@ -797,16 +798,13 @@
|
|||
},
|
||||
"type":{
|
||||
"shape":"StateMachineType",
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>The <code>type</code> of the state machine (<code>STANDARD</code> or <code>EXPRESS</code>).</p>"
|
||||
},
|
||||
"creationDate":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date the state machine is created.</p>"
|
||||
},
|
||||
"loggingConfiguration":{
|
||||
"shape":"LoggingConfiguration",
|
||||
"documentation":"<p/>"
|
||||
}
|
||||
"loggingConfiguration":{"shape":"LoggingConfiguration"}
|
||||
}
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
|
|
@ -879,7 +877,7 @@
|
|||
"members":{
|
||||
"executionArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the execution.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that id entifies the execution.</p>"
|
||||
},
|
||||
"stateMachineArn":{
|
||||
"shape":"Arn",
|
||||
|
|
@ -887,7 +885,7 @@
|
|||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"ExecutionStatus",
|
||||
|
|
@ -1477,14 +1475,14 @@
|
|||
},
|
||||
"includeExecutionData":{
|
||||
"shape":"IncludeExecutionData",
|
||||
"documentation":"<p>Determines whether execution history data is included in your log. When set to <code>FALSE</code>, data is excluded.</p>"
|
||||
"documentation":"<p>Determines whether execution data is included in your log. When set to <code>FALSE</code>, data is excluded.</p>"
|
||||
},
|
||||
"destinations":{
|
||||
"shape":"LogDestinationList",
|
||||
"documentation":"<p>An object that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to <code>OFF</code>.</p>"
|
||||
"documentation":"<p>An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to <code>OFF</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs options.</p>"
|
||||
},
|
||||
"MapIterationEventDetails":{
|
||||
"type":"structure",
|
||||
|
|
@ -1635,7 +1633,7 @@
|
|||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions\"> Limits Related to State Machine Executions</a> in the <i>AWS Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions\"> Limits Related to State Machine Executions</a> in the <i>AWS Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
|
||||
},
|
||||
"input":{
|
||||
"shape":"SensitiveData",
|
||||
|
|
@ -1652,7 +1650,7 @@
|
|||
"members":{
|
||||
"executionArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the execution.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that id entifies the execution.</p>"
|
||||
},
|
||||
"startDate":{
|
||||
"shape":"Timestamp",
|
||||
|
|
@ -1681,7 +1679,7 @@
|
|||
"members":{
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the state.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the state.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
|
||||
},
|
||||
"output":{
|
||||
"shape":"SensitiveData",
|
||||
|
|
@ -1741,7 +1739,7 @@
|
|||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the state machine.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
|
||||
"documentation":"<p>The name of the state machine.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>< > { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ & , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul> <p>To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.</p>"
|
||||
},
|
||||
"type":{
|
||||
"shape":"StateMachineType",
|
||||
|
|
@ -2131,7 +2129,7 @@
|
|||
},
|
||||
"loggingConfiguration":{
|
||||
"shape":"LoggingConfiguration",
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs options.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Returns information about a transcription job. To see the status of the job, check the <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished and you can find the results at the location specified in the <code>TranscriptionFileUri</code> field.</p>"
|
||||
"documentation":"<p>Returns information about a transcription job. To see the status of the job, check the <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>, the job is finished and you can find the results at the location specified in the <code>TranscriptFileUri</code> field. If you enable content redaction, the redacted transcript appears in <code>RedactedTranscriptFileUri</code>.</p>"
|
||||
},
|
||||
"GetVocabulary":{
|
||||
"name":"GetVocabulary",
|
||||
|
|
@ -250,6 +250,24 @@
|
|||
"documentation":"<p>When you are using the <code>CreateVocabulary</code> operation, the <code>JobName</code> field is a duplicate of a previously entered job name. Resend your request with a different name.</p> <p>When you are using the <code>UpdateVocabulary</code> operation, there are two jobs running at the same time. Resend the second request later.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ContentRedaction":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"RedactionType",
|
||||
"RedactionOutput"
|
||||
],
|
||||
"members":{
|
||||
"RedactionType":{
|
||||
"shape":"RedactionType",
|
||||
"documentation":"<p>Request parameter that defines the entities to be redacted. The only accepted value is <code>PII</code>.</p>"
|
||||
},
|
||||
"RedactionOutput":{
|
||||
"shape":"RedactionOutput",
|
||||
"documentation":"<p>Request parameter where you choose whether to output only the redacted transcript or generate an additional unredacted transcript.</p> <p>When you choose <code>redacted</code> Amazon Transcribe outputs a JSON file with only the redacted transcript and related information.</p> <p>When you choose <code>redacted_and_unredacted</code> Amazon Transcribe outputs a JSON file with the unredacted transcript and related information in addition to the JSON file with the redacted transcript.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Settings for content redaction within a transcription job.</p> <p>You can redact transcripts in US English (en-us). For more information see: <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/content-redaction.html\">Automatic Content Redaction</a> </p>"
|
||||
},
|
||||
"CreateVocabularyFilterRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -666,7 +684,7 @@
|
|||
"members":{
|
||||
"MediaFileUri":{
|
||||
"shape":"Uri",
|
||||
"documentation":"<p>The S3 location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:</p> <p> <code> https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> </code> </p> <p>For example:</p> <p> <code>https://s3.us-east-1.amazonaws.com/examplebucket/example.mp4</code> </p> <p> <code>https://s3.us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4</code> </p> <p>For more information about S3 object names, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p>"
|
||||
"documentation":"<p>The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:</p> <p> <code> s3://<bucket-name>/<keyprefix>/<objectkey> </code> </p> <p>For example:</p> <p> <code>s3://examplebucket/example.mp4</code> </p> <p> <code>s3://examplebucket/mediadocs/example.mp4</code> </p> <p>For more information about S3 object names, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys\">Object Keys</a> in the <i>Amazon S3 Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes the input media file in a transcription request.</p>"
|
||||
|
|
@ -720,6 +738,17 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Phrase"}
|
||||
},
|
||||
"RedactionOutput":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"redacted",
|
||||
"redacted_and_unredacted"
|
||||
]
|
||||
},
|
||||
"RedactionType":{
|
||||
"type":"string",
|
||||
"enum":["PII"]
|
||||
},
|
||||
"Settings":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -788,7 +817,7 @@
|
|||
},
|
||||
"OutputBucketName":{
|
||||
"shape":"OutputBucketName",
|
||||
"documentation":"<p>The location where the transcription is stored.</p> <p>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the operation returns this location in the <code>TranscriptFileUri</code> field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user\">Permissions Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.</p> <p>If you don't set the <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the <code>TranscriptFileUri</code> field. Use this URL to download the transcription.</p>"
|
||||
"documentation":"<p>The location where the transcription is stored.</p> <p>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the operation returns this location in the <code>TranscriptFileUri</code> field. If you enable content redaction, the redacted transcript appears in <code>RedactedTranscriptFileUri</code>. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the <code>TranscriptFileUri</code>. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user\">Permissions Required for IAM User Roles</a>.</p> <p>You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.</p> <p>If you don't set the <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the <code>TranscriptFileUri</code> field. Use this URL to download the transcription.</p>"
|
||||
},
|
||||
"OutputEncryptionKMSKeyId":{
|
||||
"shape":"KMSKeyId",
|
||||
|
|
@ -801,6 +830,10 @@
|
|||
"JobExecutionSettings":{
|
||||
"shape":"JobExecutionSettings",
|
||||
"documentation":"<p>Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.</p>"
|
||||
},
|
||||
"ContentRedaction":{
|
||||
"shape":"ContentRedaction",
|
||||
"documentation":"<p>An object that contains the request parameters for content redaction.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -819,7 +852,11 @@
|
|||
"members":{
|
||||
"TranscriptFileUri":{
|
||||
"shape":"Uri",
|
||||
"documentation":"<p>The location where the transcription is stored.</p> <p>Use this URI to access the transcription. If you specified an S3 bucket in the <code>OutputBucketName</code> field when you created the job, this is the URI of that bucket. If you chose to store the transcription in Amazon Transcribe, this is a shareable URL that provides secure access to that location.</p>"
|
||||
"documentation":"<p>The S3 object location of the the transcript.</p> <p>Use this URI to access the transcript. If you specified an S3 bucket in the <code>OutputBucketName</code> field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.</p>"
|
||||
},
|
||||
"RedactedTranscriptFileUri":{
|
||||
"shape":"Uri",
|
||||
"documentation":"<p>The S3 object location of the redacted transcript.</p> <p>Use this URI to access the redacated transcript. If you specified an S3 bucket in the <code>OutputBucketName</code> field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Identifies the location of a transcription.</p>"
|
||||
|
|
@ -878,6 +915,10 @@
|
|||
"JobExecutionSettings":{
|
||||
"shape":"JobExecutionSettings",
|
||||
"documentation":"<p>Provides information about how a transcription job is executed.</p>"
|
||||
},
|
||||
"ContentRedaction":{
|
||||
"shape":"ContentRedaction",
|
||||
"documentation":"<p>An object that describes content redaction settings for the transcription job.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes an asynchronous transcription job that was created with the <code>StartTranscriptionJob</code> operation. </p>"
|
||||
|
|
@ -935,6 +976,10 @@
|
|||
"OutputLocationType":{
|
||||
"shape":"OutputLocationType",
|
||||
"documentation":"<p>Indicates the location of the output of the transcription job.</p> <p>If the value is <code>CUSTOMER_BUCKET</code> then the location is the S3 bucket specified in the <code>outputBucketName</code> field when the transcription job was started with the <code>StartTranscriptionJob</code> operation.</p> <p>If the value is <code>SERVICE_BUCKET</code> then the output is stored by Amazon Transcribe and can be retrieved using the URI in the <code>GetTranscriptionJob</code> response's <code>TranscriptFileUri</code> field.</p>"
|
||||
},
|
||||
"ContentRedaction":{
|
||||
"shape":"ContentRedaction",
|
||||
"documentation":"<p>The content redaction settings of the transcription job.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides a summary of information about a transcription job.</p>"
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
{"shape":"WAFNonexistentItemException"},
|
||||
{"shape":"WAFUnavailableEntityException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </p> <p>For AWS CloudFront, you can associate the Web ACL by providing the <code>Id</code> of the <a>WebACL</a> to the CloudFront API call <code>UpdateDistribution</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a>.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </p> <p>For AWS CloudFront, you can associate the Web ACL by providing the <code>ARN</code> of the <a>WebACL</a> to the CloudFront API call <code>UpdateDistribution</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a>.</p>"
|
||||
},
|
||||
"CheckCapacity":{
|
||||
"name":"CheckCapacity",
|
||||
|
|
@ -43,7 +43,8 @@
|
|||
{"shape":"WAFNonexistentItemException"},
|
||||
{"shape":"WAFLimitsExceededException"},
|
||||
{"shape":"WAFInvalidResourceException"},
|
||||
{"shape":"WAFUnavailableEntityException"}
|
||||
{"shape":"WAFUnavailableEntityException"},
|
||||
{"shape":"WAFSubscriptionNotFoundException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a <a>RuleGroup</a> or <a>WebACL</a>. </p> <p>AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS 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. The WCU limit for web ACLs is 1,500. </p>"
|
||||
},
|
||||
|
|
@ -83,7 +84,7 @@
|
|||
{"shape":"WAFTagOperationException"},
|
||||
{"shape":"WAFTagOperationInternalErrorException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Creates a <a>RegexPatternSet</a> per the specifications provided.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Creates a <a>RegexPatternSet</a>, which you reference in a <a>RegexPatternSetReferenceStatement</a>, to have AWS WAF inspect a web request component for the specified patterns.</p>"
|
||||
},
|
||||
"CreateRuleGroup":{
|
||||
"name":"CreateRuleGroup",
|
||||
|
|
@ -101,7 +102,8 @@
|
|||
{"shape":"WAFLimitsExceededException"},
|
||||
{"shape":"WAFUnavailableEntityException"},
|
||||
{"shape":"WAFTagOperationException"},
|
||||
{"shape":"WAFTagOperationInternalErrorException"}
|
||||
{"shape":"WAFTagOperationInternalErrorException"},
|
||||
{"shape":"WAFSubscriptionNotFoundException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Creates a <a>RuleGroup</a> per the specifications provided. </p> <p> A rule group defines a collection of rules to inspect and control web requests that you can use in a <a>WebACL</a>. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. </p>"
|
||||
},
|
||||
|
|
@ -123,7 +125,8 @@
|
|||
{"shape":"WAFUnavailableEntityException"},
|
||||
{"shape":"WAFNonexistentItemException"},
|
||||
{"shape":"WAFTagOperationException"},
|
||||
{"shape":"WAFTagOperationInternalErrorException"}
|
||||
{"shape":"WAFTagOperationInternalErrorException"},
|
||||
{"shape":"WAFSubscriptionNotFoundException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <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 an action defined (allow, block, or count) for requests that match the statement of the rule. 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 AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer. </p>"
|
||||
},
|
||||
|
|
@ -140,6 +143,7 @@
|
|||
{"shape":"WAFInvalidParameterException"},
|
||||
{"shape":"WAFNonexistentItemException"},
|
||||
{"shape":"WAFOptimisticLockException"},
|
||||
{"shape":"WAFAssociatedItemException"},
|
||||
{"shape":"WAFTagOperationException"},
|
||||
{"shape":"WAFTagOperationInternalErrorException"}
|
||||
],
|
||||
|
|
@ -173,6 +177,7 @@
|
|||
{"shape":"WAFInvalidParameterException"},
|
||||
{"shape":"WAFNonexistentItemException"},
|
||||
{"shape":"WAFOptimisticLockException"},
|
||||
{"shape":"WAFAssociatedItemException"},
|
||||
{"shape":"WAFTagOperationException"},
|
||||
{"shape":"WAFTagOperationInternalErrorException"}
|
||||
],
|
||||
|
|
@ -191,6 +196,7 @@
|
|||
{"shape":"WAFInvalidParameterException"},
|
||||
{"shape":"WAFNonexistentItemException"},
|
||||
{"shape":"WAFOptimisticLockException"},
|
||||
{"shape":"WAFAssociatedItemException"},
|
||||
{"shape":"WAFTagOperationException"},
|
||||
{"shape":"WAFTagOperationInternalErrorException"}
|
||||
],
|
||||
|
|
@ -244,7 +250,7 @@
|
|||
{"shape":"WAFInvalidParameterException"},
|
||||
{"shape":"WAFNonexistentItemException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </p> <p>For AWS CloudFront, you can disassociate the Web ACL by providing an empty <code>WebACLId</code> in the CloudFront API call <code>UpdateDistribution</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a>.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </p> <p>For AWS CloudFront, you can disassociate the Web ACL by providing an empty web ACL ARN in the CloudFront API call <code>UpdateDistribution</code>. For information, see <a href=\"https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html\">UpdateDistribution</a>.</p>"
|
||||
},
|
||||
"GetIPSet":{
|
||||
"name":"GetIPSet",
|
||||
|
|
@ -378,7 +384,7 @@
|
|||
{"shape":"WAFInternalErrorException"},
|
||||
{"shape":"WAFInvalidParameterException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS managed rule groups and the AWS Marketplace managed rule groups that you're subscribed to.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS Managed Rules rule groups and the AWS Marketplace managed rule groups that you're subscribed to.</p>"
|
||||
},
|
||||
"ListIPSets":{
|
||||
"name":"ListIPSets",
|
||||
|
|
@ -585,7 +591,8 @@
|
|||
{"shape":"WAFDuplicateItemException"},
|
||||
{"shape":"WAFOptimisticLockException"},
|
||||
{"shape":"WAFLimitsExceededException"},
|
||||
{"shape":"WAFUnavailableEntityException"}
|
||||
{"shape":"WAFUnavailableEntityException"},
|
||||
{"shape":"WAFSubscriptionNotFoundException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Updates the specified <a>RuleGroup</a>.</p> <p> A rule group defines a collection of rules to inspect and control web requests that you can use in a <a>WebACL</a>. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. </p>"
|
||||
},
|
||||
|
|
@ -605,7 +612,8 @@
|
|||
{"shape":"WAFOptimisticLockException"},
|
||||
{"shape":"WAFLimitsExceededException"},
|
||||
{"shape":"WAFInvalidResourceException"},
|
||||
{"shape":"WAFUnavailableEntityException"}
|
||||
{"shape":"WAFUnavailableEntityException"},
|
||||
{"shape":"WAFSubscriptionNotFoundException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Updates the specified <a>WebACL</a>.</p> <p> A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. 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 AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer. </p>"
|
||||
}
|
||||
|
|
@ -616,13 +624,13 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>All query arguments of a web request. </p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>All query arguments of a web request. </p> <p>This is used only to indicate the web request component for AWS WAF to inspect, in the <a>FieldToMatch</a> specification. </p>"
|
||||
},
|
||||
"AllowAction":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Specifies that AWS WAF should allow requests.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Specifies that AWS WAF should allow requests.</p> <p>This is used only in the context of other settings, for example to specify values for <a>RuleAction</a> and web ACL <a>DefaultAction</a>. </p>"
|
||||
},
|
||||
"AndStatement":{
|
||||
"type":"structure",
|
||||
|
|
@ -648,7 +656,7 @@
|
|||
},
|
||||
"ResourceArn":{
|
||||
"shape":"ResourceArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to associate with the web ACL. </p> <p>The ARN must be in one of the following formats:</p> <ul> <li> <p>For a CloudFront distribution: <code>arn:aws:cloudfront::<i>account-id</i>:distribution/<i>distribution-id</i> </code> </p> </li> <li> <p>For an Application Load Balancer: <code>arn:aws:elasticloadbalancing: <i>region</i>:<i>account-id</i>:loadbalancer/app/<i>load-balancer-name</i> /<i>load-balancer-id</i> </code> </p> </li> <li> <p>For an Amazon API Gateway stage: <code>arn:aws:apigateway:<i>region</i> ::/restapis/<i>api-id</i>/stages/<i>stage-name</i> </code> </p> </li> </ul>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to associate with the web ACL. </p> <p>The ARN must be in one of the following formats:</p> <ul> <li> <p>For an Application Load Balancer: <code>arn:aws:elasticloadbalancing:<i>region</i>:<i>account-id</i>:loadbalancer/app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> </p> </li> <li> <p>For an Amazon API Gateway stage: <code>arn:aws:apigateway:<i>region</i>::/restapis/<i>api-id</i>/stages/<i>stage-name</i> </code> </p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -661,13 +669,13 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Specifies that AWS WAF should block requests.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Specifies that AWS WAF should block requests.</p> <p>This is used only in the context of other settings, for example to specify values for <a>RuleAction</a> and web ACL <a>DefaultAction</a>. </p>"
|
||||
},
|
||||
"Body":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>The body of a web request. This immediately follows the request headers.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>The body of a web request. This immediately follows the request headers.</p> <p>This is used only to indicate the web request component for AWS WAF to inspect, in the <a>FieldToMatch</a> specification. </p>"
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"ByteMatchStatement":{
|
||||
|
|
@ -747,7 +755,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Specifies that AWS WAF should count requests.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Specifies that AWS WAF should count requests.</p> <p>This is used only in the context of other settings, for example to specify values for <a>RuleAction</a> and web ACL <a>DefaultAction</a>. </p>"
|
||||
},
|
||||
"Country":{"type":"string"},
|
||||
"CountryCode":{
|
||||
|
|
@ -1200,7 +1208,7 @@
|
|||
"documentation":"<p>Specifies that AWS WAF should allow requests by default.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>In a <code>WebACL</code>, this is the action that you want AWS WAF to perform when a web request doesn't match any of the rules in the <code>WebACL</code>. The default action must be a terminating action, so count is not allowed.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>In a <a>WebACL</a>, this is the action that you want AWS WAF to perform when a web request doesn't match any of the rules in the <code>WebACL</code>. The default action must be a terminating action, so count is not allowed.</p>"
|
||||
},
|
||||
"DeleteIPSetRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1386,7 +1394,7 @@
|
|||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"ResourceArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL. </p> <p>The ARN must be in one of the following formats:</p> <ul> <li> <p>For a CloudFront distribution: <code>arn:aws:cloudfront::<i>account-id</i>:distribution/<i>distribution-id</i> </code> </p> </li> <li> <p>For an Application Load Balancer: <code>arn:aws:elasticloadbalancing: <i>region</i>:<i>account-id</i>:loadbalancer/app/<i>load-balancer-name</i> /<i>load-balancer-id</i> </code> </p> </li> <li> <p>For an Amazon API Gateway stage: <code>arn:aws:apigateway:<i>region</i> ::/restapis/<i>api-id</i>/stages/<i>stage-name</i> </code> </p> </li> </ul>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL. </p> <p>The ARN must be in one of the following formats:</p> <ul> <li> <p>For an Application Load Balancer: <code>arn:aws:elasticloadbalancing:<i>region</i>:<i>account-id</i>:loadbalancer/app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> </p> </li> <li> <p>For an Amazon API Gateway stage: <code>arn:aws:apigateway:<i>region</i>::/restapis/<i>api-id</i>/stages/<i>stage-name</i> </code> </p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1439,7 +1447,7 @@
|
|||
},
|
||||
"SingleQueryArgument":{
|
||||
"shape":"SingleQueryArgument",
|
||||
"documentation":"<p>Inspect a single query argument. Provide the name of the query argument to inspect, such as <i>UserName</i> or <i>SalesRegion</i>. The name can be up to 30 characters long and isn't case sensitive. </p>"
|
||||
"documentation":"<p>Inspect a single query argument. Provide the name of the query argument to inspect, such as <i>UserName</i> or <i>SalesRegion</i>. The name can be up to 30 characters long and isn't case sensitive. </p> <p>This is used only to indicate the web request component for AWS WAF to inspect, in the <a>FieldToMatch</a> specification. </p>"
|
||||
},
|
||||
"AllQueryArguments":{
|
||||
"shape":"AllQueryArguments",
|
||||
|
|
@ -1455,7 +1463,7 @@
|
|||
},
|
||||
"Body":{
|
||||
"shape":"Body",
|
||||
"documentation":"<p>Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. </p> <p>Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as <a>ByteMatchStatement</a> or <a>RegexPatternSetReferenceStatement</a>, with a <a>SizeConstraintStatement</a> that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.</p>"
|
||||
"documentation":"<p>Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. </p> <p>Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as <a>ByteMatchStatement</a> or <a>RegexPatternSetReferenceStatement</a>, with a <a>SizeConstraintStatement</a> that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.</p>"
|
||||
},
|
||||
"Method":{
|
||||
"shape":"Method",
|
||||
|
|
@ -2216,16 +2224,16 @@
|
|||
},
|
||||
"Description":{
|
||||
"shape":"EntityDescription",
|
||||
"documentation":"<p>The description of the managed rule group, provided by AWS or the AWS Marketplace seller who manages it.</p>"
|
||||
"documentation":"<p>The description of the managed rule group, provided by AWS Managed Rules or the AWS Marketplace seller who manages it.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>High-level information about a managed rule group, returned by <a>ListAvailableManagedRuleGroups</a>. This provides information like the name and vendor name, that you provide when you add a <a>ManagedRuleGroupStatement</a> to a web ACL. Managed rule groups include AWS managed rule groups, which are free of charge to AWS WAF customers, and AWS Marketplace managed rule groups, which you can subscribe to through AWS Marketplace. </p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>High-level information about a managed rule group, returned by <a>ListAvailableManagedRuleGroups</a>. This provides information like the name and vendor name, that you provide when you add a <a>ManagedRuleGroupStatement</a> to a web ACL. Managed rule groups include AWS Managed Rules rule groups, which are free of charge to AWS WAF customers, and AWS Marketplace managed rule groups, which you can subscribe to through AWS Marketplace. </p>"
|
||||
},
|
||||
"Method":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform. </p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform. </p> <p>This is used only to indicate the web request component for AWS WAF to inspect, in the <a>FieldToMatch</a> specification. </p>"
|
||||
},
|
||||
"MetricName":{
|
||||
"type":"string",
|
||||
|
|
@ -2243,7 +2251,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Specifies that AWS WAF should do nothing. This is generally used to try out a rule without performing any actions. You set the <code>OverrideAction</code> on the <a>Rule</a>, and override the actions that are set at the statement level. </p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Specifies that AWS WAF should do nothing. This is generally used to try out a rule without performing any actions. You set the <code>OverrideAction</code> on the <a>Rule</a>. </p> <p>This is used only in the context of other settings, for example to specify values for <a>RuleAction</a> and web ACL <a>DefaultAction</a>. </p>"
|
||||
},
|
||||
"NotStatement":{
|
||||
"type":"structure",
|
||||
|
|
@ -2324,7 +2332,8 @@
|
|||
"RESOURCE_ARN",
|
||||
"RESOURCE_TYPE",
|
||||
"TAGS",
|
||||
"TAG_KEYS"
|
||||
"TAG_KEYS",
|
||||
"METRIC_NAME"
|
||||
]
|
||||
},
|
||||
"ParameterExceptionParameter":{
|
||||
|
|
@ -2365,7 +2374,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>The query string of a web request. This is the part of a URL that appears after a <code>?</code> character, if any.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>The query string of a web request. This is the part of a URL that appears after a <code>?</code> character, if any.</p> <p>This is used only to indicate the web request component for AWS WAF to inspect, in the <a>FieldToMatch</a> specification. </p>"
|
||||
},
|
||||
"RateBasedStatement":{
|
||||
"type":"structure",
|
||||
|
|
@ -2749,7 +2758,7 @@
|
|||
"documentation":"<p>The name of the query header to inspect.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>One of the headers in a web request, identified by name, for example, <code>User-Agent</code> or <code>Referer</code>. This setting isn't case sensitive.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>One of the headers in a web request, identified by name, for example, <code>User-Agent</code> or <code>Referer</code>. This setting isn't case sensitive.</p> <p>This is used only to indicate the web request component for AWS WAF to inspect, in the <a>FieldToMatch</a> specification. </p>"
|
||||
},
|
||||
"SingleQueryArgument":{
|
||||
"type":"structure",
|
||||
|
|
@ -3228,7 +3237,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, <code>/images/daily-ad.jpg</code>.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, <code>/images/daily-ad.jpg</code>.</p> <p>This is used only to indicate the web request component for AWS WAF to inspect, in the <a>FieldToMatch</a> specification. </p>"
|
||||
},
|
||||
"VendorName":{
|
||||
"type":"string",
|
||||
|
|
@ -3335,6 +3344,14 @@
|
|||
"documentation":"<p>AWS WAF is not able to access the service linked role. This can be caused by a previous <code>PutLoggingConfiguration</code> request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous <code>DeleteServiceLinkedRole</code> request, which can lock the role for 15 minutes or more. If you recently made a call to <code>DeleteServiceLinkedRole</code>, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"WAFSubscriptionNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p/>",
|
||||
"exception":true
|
||||
},
|
||||
"WAFTagOperationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
|
|||
|
|
@ -525,7 +525,7 @@
|
|||
{"shape":"FailedDependencyException"},
|
||||
{"shape":"ServiceUnavailableException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.</p>"
|
||||
"documentation":"<p>Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.</p> <p>This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see <a href=\"https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html\">Authentication and Access Control for User Applications</a> in the <i>Amazon WorkDocs Developer Guide</i>.</p>"
|
||||
},
|
||||
"GetDocument":{
|
||||
"name":"GetDocument",
|
||||
|
|
@ -793,7 +793,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -823,7 +823,7 @@
|
|||
},
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
}
|
||||
|
|
@ -933,7 +933,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1104,7 +1104,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1160,7 +1160,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1193,7 +1193,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1235,7 +1235,7 @@
|
|||
},
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
}
|
||||
|
|
@ -1327,7 +1327,7 @@
|
|||
},
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
}
|
||||
|
|
@ -1387,7 +1387,7 @@
|
|||
},
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
}
|
||||
|
|
@ -1411,7 +1411,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1441,7 +1441,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1482,7 +1482,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1500,7 +1500,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1518,7 +1518,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1542,7 +1542,7 @@
|
|||
},
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1609,7 +1609,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1691,7 +1691,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1740,7 +1740,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1795,7 +1795,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1866,7 +1866,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -1952,7 +1952,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -2001,7 +2001,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -2037,7 +2037,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -2397,7 +2397,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
}
|
||||
|
|
@ -2418,7 +2418,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -2463,7 +2463,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -2503,7 +2503,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -2552,7 +2552,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -2597,7 +2597,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -2633,7 +2633,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>The Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API operation using AWS credentials.</p>",
|
||||
"documentation":"<p>The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -2737,7 +2737,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -2986,7 +2986,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -3007,7 +3007,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -3390,7 +3390,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -3423,7 +3423,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -3451,7 +3451,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
@ -3481,7 +3481,7 @@
|
|||
"members":{
|
||||
"AuthenticationToken":{
|
||||
"shape":"AuthenticationHeaderType",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.</p>",
|
||||
"documentation":"<p>Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Authentication"
|
||||
},
|
||||
|
|
|
|||
|
|
@ -136,6 +136,20 @@
|
|||
"documentation":"<p>Creates a user who can be used in Amazon WorkMail by calling the <a>RegisterToWorkMail</a> operation.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"DeleteAccessControlRule":{
|
||||
"name":"DeleteAccessControlRule",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteAccessControlRuleRequest"},
|
||||
"output":{"shape":"DeleteAccessControlRuleResponse"},
|
||||
"errors":[
|
||||
{"shape":"OrganizationNotFoundException"},
|
||||
{"shape":"OrganizationStateException"}
|
||||
],
|
||||
"documentation":"<p>Deletes an access control rule for the specified WorkMail organization.</p>"
|
||||
},
|
||||
"DeleteAlias":{
|
||||
"name":"DeleteAlias",
|
||||
"http":{
|
||||
|
|
@ -352,6 +366,22 @@
|
|||
"documentation":"<p>Removes a member from a group.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"GetAccessControlEffect":{
|
||||
"name":"GetAccessControlEffect",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetAccessControlEffectRequest"},
|
||||
"output":{"shape":"GetAccessControlEffectResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"OrganizationNotFoundException"},
|
||||
{"shape":"OrganizationStateException"}
|
||||
],
|
||||
"documentation":"<p>Gets the effects of an organization's access control rules as they apply to a specified IPv4 address, access protocol action, or user ID. </p>"
|
||||
},
|
||||
"GetMailboxDetails":{
|
||||
"name":"GetMailboxDetails",
|
||||
"http":{
|
||||
|
|
@ -368,6 +398,20 @@
|
|||
"documentation":"<p>Requests a user's mailbox details for a specified organization and user.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"ListAccessControlRules":{
|
||||
"name":"ListAccessControlRules",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListAccessControlRulesRequest"},
|
||||
"output":{"shape":"ListAccessControlRulesResponse"},
|
||||
"errors":[
|
||||
{"shape":"OrganizationNotFoundException"},
|
||||
{"shape":"OrganizationStateException"}
|
||||
],
|
||||
"documentation":"<p>Lists the access control rules for the specified organization.</p>"
|
||||
},
|
||||
"ListAliases":{
|
||||
"name":"ListAliases",
|
||||
"http":{
|
||||
|
|
@ -515,6 +559,23 @@
|
|||
"documentation":"<p>Returns summaries of the organization's users.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"PutAccessControlRule":{
|
||||
"name":"PutAccessControlRule",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"PutAccessControlRuleRequest"},
|
||||
"output":{"shape":"PutAccessControlRuleResponse"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"OrganizationNotFoundException"},
|
||||
{"shape":"OrganizationStateException"}
|
||||
],
|
||||
"documentation":"<p>Adds a new access control rule for the specified organization. The rule allows or denies access to the organization for the specified IPv4 addresses, access protocol actions, and user IDs. Adding a new rule with the same name as an existing rule replaces the older rule.</p>"
|
||||
},
|
||||
"PutMailboxPermissions":{
|
||||
"name":"PutMailboxPermissions",
|
||||
"http":{
|
||||
|
|
@ -554,7 +615,7 @@
|
|||
{"shape":"OrganizationNotFoundException"},
|
||||
{"shape":"OrganizationStateException"}
|
||||
],
|
||||
"documentation":"<p>Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see <a href=\"https://aws.amazon.com//workmail/pricing\">Pricing</a>. The equivalent console functionality for this operation is <i>Enable</i>. </p> <p>Users can either be created by calling the <a>CreateUser</a> API operation or they can be synchronized from your directory. For more information, see <a>DeregisterFromWorkMail</a>.</p>",
|
||||
"documentation":"<p>Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see <a href=\"https://aws.amazon.com/workmail/pricing\">Pricing</a>. The equivalent console functionality for this operation is <i>Enable</i>. </p> <p>Users can either be created by calling the <a>CreateUser</a> API operation or they can be synchronized from your directory. For more information, see <a>DeregisterFromWorkMail</a>.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"ResetPassword":{
|
||||
|
|
@ -675,6 +736,99 @@
|
|||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccessControlRule":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"AccessControlRuleName",
|
||||
"documentation":"<p>The rule name.</p>"
|
||||
},
|
||||
"Effect":{
|
||||
"shape":"AccessControlRuleEffect",
|
||||
"documentation":"<p>The rule effect.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"AccessControlRuleDescription",
|
||||
"documentation":"<p>The rule description.</p>"
|
||||
},
|
||||
"IpRanges":{
|
||||
"shape":"IpRangeList",
|
||||
"documentation":"<p>IPv4 CIDR ranges to include in the rule.</p>"
|
||||
},
|
||||
"NotIpRanges":{
|
||||
"shape":"IpRangeList",
|
||||
"documentation":"<p>IPv4 CIDR ranges to exclude from the rule.</p>"
|
||||
},
|
||||
"Actions":{
|
||||
"shape":"ActionsList",
|
||||
"documentation":"<p>Access protocol actions to include in the rule. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>"
|
||||
},
|
||||
"NotActions":{
|
||||
"shape":"ActionsList",
|
||||
"documentation":"<p>Access protocol actions to exclude from the rule. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>"
|
||||
},
|
||||
"UserIds":{
|
||||
"shape":"UserIdList",
|
||||
"documentation":"<p>User IDs to include in the rule.</p>"
|
||||
},
|
||||
"NotUserIds":{
|
||||
"shape":"UserIdList",
|
||||
"documentation":"<p>User IDs to exclude from the rule.</p>"
|
||||
},
|
||||
"DateCreated":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date that the rule was created.</p>"
|
||||
},
|
||||
"DateModified":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date that the rule was modified.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A rule that controls access to an Amazon WorkMail organization.</p>"
|
||||
},
|
||||
"AccessControlRuleAction":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z]+"
|
||||
},
|
||||
"AccessControlRuleDescription":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":0,
|
||||
"pattern":"[\\u0020-\\u00FF]+"
|
||||
},
|
||||
"AccessControlRuleEffect":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ALLOW",
|
||||
"DENY"
|
||||
]
|
||||
},
|
||||
"AccessControlRuleName":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z0-9_-]+"
|
||||
},
|
||||
"AccessControlRuleNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AccessControlRuleName"},
|
||||
"max":10,
|
||||
"min":0
|
||||
},
|
||||
"AccessControlRulesList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AccessControlRule"},
|
||||
"max":10,
|
||||
"min":0
|
||||
},
|
||||
"ActionsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AccessControlRuleAction"},
|
||||
"max":10,
|
||||
"min":0
|
||||
},
|
||||
"Aliases":{
|
||||
"type":"list",
|
||||
"member":{"shape":"EmailAddress"}
|
||||
|
|
@ -895,6 +1049,25 @@
|
|||
},
|
||||
"documentation":"<p>The name of the attribute, which is one of the values defined in the UserAttribute enumeration.</p>"
|
||||
},
|
||||
"DeleteAccessControlRuleRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"OrganizationId":{
|
||||
"shape":"OrganizationId",
|
||||
"documentation":"<p>The identifier for the organization.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"AccessControlRuleName",
|
||||
"documentation":"<p>The name of the access control rule.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteAccessControlRuleResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteAliasRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1358,6 +1531,46 @@
|
|||
"documentation":"<p>You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"GetAccessControlEffectRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"OrganizationId",
|
||||
"IpAddress",
|
||||
"Action",
|
||||
"UserId"
|
||||
],
|
||||
"members":{
|
||||
"OrganizationId":{
|
||||
"shape":"OrganizationId",
|
||||
"documentation":"<p>The identifier for the organization.</p>"
|
||||
},
|
||||
"IpAddress":{
|
||||
"shape":"IpAddress",
|
||||
"documentation":"<p>The IPv4 address.</p>"
|
||||
},
|
||||
"Action":{
|
||||
"shape":"AccessControlRuleAction",
|
||||
"documentation":"<p>The access protocol action. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>"
|
||||
},
|
||||
"UserId":{
|
||||
"shape":"WorkMailIdentifier",
|
||||
"documentation":"<p>The user ID.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetAccessControlEffectResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Effect":{
|
||||
"shape":"AccessControlRuleEffect",
|
||||
"documentation":"<p>The rule effect.</p>"
|
||||
},
|
||||
"MatchedRules":{
|
||||
"shape":"AccessControlRuleNameList",
|
||||
"documentation":"<p>The rules that match the given parameters, resulting in an effect.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetMailboxDetailsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1452,6 +1665,24 @@
|
|||
"documentation":"<p>The supplied password doesn't match the minimum security constraints, such as length or use of special characters.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"IpAddress":{
|
||||
"type":"string",
|
||||
"max":15,
|
||||
"min":1,
|
||||
"pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$"
|
||||
},
|
||||
"IpRange":{
|
||||
"type":"string",
|
||||
"max":18,
|
||||
"min":1,
|
||||
"pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])/([0-9]|[12][0-9]|3[0-2])$"
|
||||
},
|
||||
"IpRangeList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"IpRange"},
|
||||
"max":10,
|
||||
"min":0
|
||||
},
|
||||
"LimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1460,6 +1691,25 @@
|
|||
"documentation":"<p>The request exceeds the limit of the resource.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ListAccessControlRulesRequest":{
|
||||
"type":"structure",
|
||||
"required":["OrganizationId"],
|
||||
"members":{
|
||||
"OrganizationId":{
|
||||
"shape":"OrganizationId",
|
||||
"documentation":"<p>The identifier for the organization.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListAccessControlRulesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Rules":{
|
||||
"shape":"AccessControlRulesList",
|
||||
"documentation":"<p>The access control rules.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListAliasesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1932,6 +2182,62 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Permission"}
|
||||
},
|
||||
"PutAccessControlRuleRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"Effect",
|
||||
"Description",
|
||||
"OrganizationId"
|
||||
],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"AccessControlRuleName",
|
||||
"documentation":"<p>The rule name.</p>"
|
||||
},
|
||||
"Effect":{
|
||||
"shape":"AccessControlRuleEffect",
|
||||
"documentation":"<p>The rule effect.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"AccessControlRuleDescription",
|
||||
"documentation":"<p>The rule description.</p>"
|
||||
},
|
||||
"IpRanges":{
|
||||
"shape":"IpRangeList",
|
||||
"documentation":"<p>IPv4 CIDR ranges to include in the rule.</p>"
|
||||
},
|
||||
"NotIpRanges":{
|
||||
"shape":"IpRangeList",
|
||||
"documentation":"<p>IPv4 CIDR ranges to exclude from the rule.</p>"
|
||||
},
|
||||
"Actions":{
|
||||
"shape":"ActionsList",
|
||||
"documentation":"<p>Access protocol actions to include in the rule. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>"
|
||||
},
|
||||
"NotActions":{
|
||||
"shape":"ActionsList",
|
||||
"documentation":"<p>Access protocol actions to exclude from the rule. Valid values include <code>ActiveSync</code>, <code>AutoDiscover</code>, <code>EWS</code>, <code>IMAP</code>, <code>SMTP</code>, <code>WindowsOutlook</code>, and <code>WebMail</code>.</p>"
|
||||
},
|
||||
"UserIds":{
|
||||
"shape":"UserIdList",
|
||||
"documentation":"<p>User IDs to include in the rule.</p>"
|
||||
},
|
||||
"NotUserIds":{
|
||||
"shape":"UserIdList",
|
||||
"documentation":"<p>User IDs to exclude from the rule.</p>"
|
||||
},
|
||||
"OrganizationId":{
|
||||
"shape":"OrganizationId",
|
||||
"documentation":"<p>The identifier of the organization.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PutAccessControlRuleResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"PutMailboxPermissionsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2320,6 +2626,12 @@
|
|||
},
|
||||
"documentation":"<p>The representation of an Amazon WorkMail user.</p>"
|
||||
},
|
||||
"UserIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"WorkMailIdentifier"},
|
||||
"max":10,
|
||||
"min":0
|
||||
},
|
||||
"UserName":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
|
|
|
|||
|
|
@ -480,7 +480,15 @@ class InvalidMaxRetryAttemptsError(InvalidRetryConfigurationError):
|
|||
"""Error when invalid retry configuration is specified"""
|
||||
fmt = (
|
||||
'Value provided to "max_attempts": {provided_max_attempts} must '
|
||||
'be an integer greater than or equal to zero.'
|
||||
'be an integer greater than or equal to {min_value}.'
|
||||
)
|
||||
|
||||
|
||||
class InvalidRetryModeError(InvalidRetryConfigurationError):
|
||||
"""Error when invalid retry mode configuration is specified"""
|
||||
fmt = (
|
||||
'Invalid value provided to "mode": "{provided_retry_mode}" must '
|
||||
'be one of: "legacy", "standard", "adaptive"'
|
||||
)
|
||||
|
||||
|
||||
|
|
@ -549,3 +557,9 @@ class MissingServiceIdError(UndefinedModelAttributeError):
|
|||
msg = self.fmt.format(**kwargs)
|
||||
Exception.__init__(self, msg)
|
||||
self.kwargs = kwargs
|
||||
|
||||
|
||||
class CapacityNotAvailableError(BotoCoreError):
|
||||
fmt = (
|
||||
'Insufficient request capacity available.'
|
||||
)
|
||||
|
|
|
|||
|
|
@ -484,8 +484,7 @@ def parse_get_bucket_location(parsed, http_response, **kwargs):
|
|||
# The "parsed" passed in only has the ResponseMetadata
|
||||
# filled out. This handler will fill in the LocationConstraint
|
||||
# value.
|
||||
if 'LocationConstraint' in parsed:
|
||||
# Response already set - a stub?
|
||||
if http_response.raw is None:
|
||||
return
|
||||
response_body = http_response.content
|
||||
parser = xml.etree.cElementTree.XMLParser(
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ class Shape(object):
|
|||
'jsonvalue', 'timestampFormat', 'hostLabel']
|
||||
METADATA_ATTRS = ['required', 'min', 'max', 'sensitive', 'enum',
|
||||
'idempotencyToken', 'error', 'exception',
|
||||
'endpointdiscoveryid']
|
||||
'endpointdiscoveryid', 'retryable']
|
||||
MAP_TYPE = OrderedDict
|
||||
|
||||
def __init__(self, shape_name, shape_model, shape_resolver=None):
|
||||
|
|
|
|||
6
botocore/retries/__init__.py
Normal file
6
botocore/retries/__init__.py
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
"""New retry v2 handlers.
|
||||
|
||||
This package obsoletes the botocore/retryhandler.py module and contains
|
||||
new retry logic.
|
||||
|
||||
"""
|
||||
117
botocore/retries/adaptive.py
Normal file
117
botocore/retries/adaptive.py
Normal file
|
|
@ -0,0 +1,117 @@
|
|||
import math
|
||||
import logging
|
||||
import threading
|
||||
|
||||
from botocore.retries import bucket
|
||||
from botocore.retries import throttling
|
||||
from botocore.retries import standard
|
||||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def register_retry_handler(client):
|
||||
clock = bucket.Clock()
|
||||
rate_adjustor = throttling.CubicCalculator(starting_max_rate=0,
|
||||
start_time=clock.current_time())
|
||||
token_bucket = bucket.TokenBucket(max_rate=1, clock=clock)
|
||||
rate_clocker = RateClocker(clock)
|
||||
throttling_detector = standard.ThrottlingErrorDetector(
|
||||
retry_event_adapter=standard.RetryEventAdapter(),
|
||||
)
|
||||
limiter = ClientRateLimiter(
|
||||
rate_adjustor=rate_adjustor,
|
||||
rate_clocker=rate_clocker,
|
||||
token_bucket=token_bucket,
|
||||
throttling_detector=throttling_detector,
|
||||
clock=clock,
|
||||
)
|
||||
client.meta.events.register(
|
||||
'before-send', limiter.on_sending_request,
|
||||
)
|
||||
client.meta.events.register(
|
||||
'needs-retry', limiter.on_receiving_response,
|
||||
)
|
||||
return limiter
|
||||
|
||||
|
||||
class ClientRateLimiter(object):
|
||||
|
||||
_MAX_RATE_ADJUST_SCALE = 2.0
|
||||
|
||||
def __init__(self, rate_adjustor, rate_clocker, token_bucket,
|
||||
throttling_detector, clock):
|
||||
self._rate_adjustor = rate_adjustor
|
||||
self._rate_clocker = rate_clocker
|
||||
self._token_bucket = token_bucket
|
||||
self._throttling_detector = throttling_detector
|
||||
self._clock = clock
|
||||
self._enabled = False
|
||||
self._lock = threading.Lock()
|
||||
|
||||
def on_sending_request(self, request, **kwargs):
|
||||
if self._enabled:
|
||||
self._token_bucket.acquire()
|
||||
|
||||
# Hooked up to needs-retry.
|
||||
def on_receiving_response(self, **kwargs):
|
||||
measured_rate = self._rate_clocker.record()
|
||||
timestamp = self._clock.current_time()
|
||||
with self._lock:
|
||||
if not self._throttling_detector.is_throttling_error(**kwargs):
|
||||
throttling = False
|
||||
new_rate = self._rate_adjustor.success_received(timestamp)
|
||||
else:
|
||||
throttling = True
|
||||
if not self._enabled:
|
||||
rate_to_use = measured_rate
|
||||
else:
|
||||
rate_to_use = min(measured_rate, self._token_bucket.max_rate)
|
||||
new_rate = self._rate_adjustor.error_received(
|
||||
rate_to_use, timestamp)
|
||||
logger.debug("Throttling response received, new send rate: %s "
|
||||
"measured rate: %s, token bucket capacity "
|
||||
"available: %s", new_rate, measured_rate,
|
||||
self._token_bucket.available_capacity)
|
||||
self._enabled = True
|
||||
self._token_bucket.max_rate = min(
|
||||
new_rate, self._MAX_RATE_ADJUST_SCALE * measured_rate)
|
||||
|
||||
|
||||
class RateClocker(object):
|
||||
"""Tracks the rate at which a client is sending a request."""
|
||||
|
||||
_DEFAULT_SMOOTHING = 0.8
|
||||
# Update the rate every _TIME_BUCKET_RANGE seconds.
|
||||
_TIME_BUCKET_RANGE = 0.5
|
||||
|
||||
def __init__(self, clock, smoothing=_DEFAULT_SMOOTHING,
|
||||
time_bucket_range=_TIME_BUCKET_RANGE):
|
||||
self._clock = clock
|
||||
self._measured_rate = 0
|
||||
self._smoothing = smoothing
|
||||
self._last_bucket = math.floor(self._clock.current_time())
|
||||
self._time_bucket_scale = 1 / self._TIME_BUCKET_RANGE
|
||||
self._count = 0
|
||||
self._lock = threading.Lock()
|
||||
|
||||
def record(self, amount=1):
|
||||
with self._lock:
|
||||
t = self._clock.current_time()
|
||||
bucket = math.floor(
|
||||
t * self._time_bucket_scale) / self._time_bucket_scale
|
||||
self._count += amount
|
||||
if bucket > self._last_bucket:
|
||||
current_rate = self._count / float(
|
||||
bucket - self._last_bucket)
|
||||
self._measured_rate = (
|
||||
(current_rate * self._smoothing) +
|
||||
(self._measured_rate * (1 - self._smoothing))
|
||||
)
|
||||
self._count = 0
|
||||
self._last_bucket = bucket
|
||||
return self._measured_rate
|
||||
|
||||
@property
|
||||
def measured_rate(self):
|
||||
return self._measured_rate
|
||||
27
botocore/retries/base.py
Normal file
27
botocore/retries/base.py
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
class BaseRetryBackoff(object):
|
||||
|
||||
def delay_amount(self, context):
|
||||
"""Calculate how long we should delay before retrying.
|
||||
|
||||
:type context: RetryContext
|
||||
|
||||
"""
|
||||
raise NotImplementedError("delay_amount")
|
||||
|
||||
|
||||
class BaseRetryableChecker(object):
|
||||
"""Base class for determining if a retry should happen.
|
||||
|
||||
This base class checks for specific retryable conditions.
|
||||
A single retryable checker doesn't necessarily indicate a retry
|
||||
will happen. It's up to the ``RetryPolicy`` to use its
|
||||
``BaseRetryableCheckers`` to make the final decision on whether a retry
|
||||
should happen.
|
||||
"""
|
||||
|
||||
def is_retryable(self, context):
|
||||
"""Returns True if retryable, False if not.
|
||||
|
||||
:type context: RetryContext
|
||||
"""
|
||||
raise NotImplementedError("is_retryable")
|
||||
114
botocore/retries/bucket.py
Normal file
114
botocore/retries/bucket.py
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
"""This module implements token buckets used for client side throttling."""
|
||||
import time
|
||||
import threading
|
||||
|
||||
from botocore.exceptions import CapacityNotAvailableError
|
||||
|
||||
|
||||
class Clock(object):
|
||||
def __init__(self):
|
||||
pass
|
||||
|
||||
def sleep(self, amount):
|
||||
time.sleep(amount)
|
||||
|
||||
def current_time(self):
|
||||
return time.time()
|
||||
|
||||
|
||||
class TokenBucket(object):
|
||||
|
||||
_MIN_RATE = 0.5
|
||||
|
||||
def __init__(self, max_rate, clock, min_rate=_MIN_RATE):
|
||||
self._fill_rate = None
|
||||
self._max_capacity = None
|
||||
self._current_capacity = 0
|
||||
self._clock = clock
|
||||
self._last_timestamp = None
|
||||
self._min_rate = min_rate
|
||||
self._lock = threading.Lock()
|
||||
self._new_fill_rate_condition = threading.Condition(self._lock)
|
||||
self.max_rate = max_rate
|
||||
|
||||
@property
|
||||
def max_rate(self):
|
||||
return self._fill_rate
|
||||
|
||||
@max_rate.setter
|
||||
def max_rate(self, value):
|
||||
with self._new_fill_rate_condition:
|
||||
# Before we can change the rate we need to fill any pending
|
||||
# tokens we might have based on the current rate. If we don't
|
||||
# do this it means everything since the last recorded timestamp
|
||||
# will accumulate at the rate we're about to set which isn't
|
||||
# correct.
|
||||
self._refill()
|
||||
self._fill_rate = max(value, self._min_rate)
|
||||
if value >= 1:
|
||||
self._max_capacity = value
|
||||
else:
|
||||
self._max_capacity = 1
|
||||
# If we're scaling down, we also can't have a capacity that's
|
||||
# more than our max_capacity.
|
||||
self._current_capacity = min(self._current_capacity,
|
||||
self._max_capacity)
|
||||
self._new_fill_rate_condition.notify()
|
||||
|
||||
@property
|
||||
def max_capacity(self):
|
||||
return self._max_capacity
|
||||
|
||||
@property
|
||||
def available_capacity(self):
|
||||
return self._current_capacity
|
||||
|
||||
def acquire(self, amount=1, block=True):
|
||||
"""Acquire token or return amount of time until next token available.
|
||||
|
||||
If block is True, then this method will block until there's sufficient
|
||||
capacity to acquire the desired amount.
|
||||
|
||||
If block is False, then this method will return True is capacity
|
||||
was successfully acquired, False otherwise.
|
||||
|
||||
"""
|
||||
with self._new_fill_rate_condition:
|
||||
return self._acquire(amount=amount, block=block)
|
||||
|
||||
def _acquire(self, amount, block):
|
||||
self._refill()
|
||||
if amount <= self._current_capacity:
|
||||
self._current_capacity -= amount
|
||||
return True
|
||||
else:
|
||||
if not block:
|
||||
raise CapacityNotAvailableError()
|
||||
# Not enough capacity.
|
||||
sleep_amount = self._sleep_amount(amount)
|
||||
while sleep_amount > 0:
|
||||
# Until python3.2, wait() always returned None so we can't
|
||||
# tell if a timeout occurred waiting on the cond var.
|
||||
# Because of this we'll unconditionally call _refill().
|
||||
# The downside to this is that we were waken up via
|
||||
# a notify(), we're calling unnecessarily calling _refill() an
|
||||
# extra time.
|
||||
self._new_fill_rate_condition.wait(sleep_amount)
|
||||
self._refill()
|
||||
sleep_amount = self._sleep_amount(amount)
|
||||
self._current_capacity -= amount
|
||||
return True
|
||||
|
||||
def _sleep_amount(self, amount):
|
||||
return (amount - self._current_capacity) / self._fill_rate
|
||||
|
||||
def _refill(self):
|
||||
timestamp = self._clock.current_time()
|
||||
if self._last_timestamp is None:
|
||||
self._last_timestamp = timestamp
|
||||
return
|
||||
current_capacity = self._current_capacity
|
||||
fill_amount = (timestamp - self._last_timestamp) * self._fill_rate
|
||||
new_capacity = min(self._max_capacity, current_capacity + fill_amount)
|
||||
self._current_capacity = new_capacity
|
||||
self._last_timestamp = timestamp
|
||||
57
botocore/retries/quota.py
Normal file
57
botocore/retries/quota.py
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
"""Retry quota implementation.
|
||||
|
||||
|
||||
"""
|
||||
import threading
|
||||
|
||||
|
||||
class RetryQuota(object):
|
||||
INITIAL_CAPACITY = 500
|
||||
|
||||
def __init__(self, initial_capacity=INITIAL_CAPACITY, lock=None):
|
||||
self._max_capacity = initial_capacity
|
||||
self._available_capacity = initial_capacity
|
||||
if lock is None:
|
||||
lock = threading.Lock()
|
||||
self._lock = lock
|
||||
|
||||
def acquire(self, capacity_amount):
|
||||
"""Attempt to aquire a certain amount of capacity.
|
||||
|
||||
If there's not sufficient amount of capacity available, ``False``
|
||||
is returned. Otherwise, ``True`` is returned, which indicates that
|
||||
capacity was successfully allocated.
|
||||
|
||||
"""
|
||||
# The acquire() is only called when we encounter a retryable
|
||||
# response so we aren't worried about locking the entire method.
|
||||
with self._lock:
|
||||
if capacity_amount > self._available_capacity:
|
||||
return False
|
||||
self._available_capacity -= capacity_amount
|
||||
return True
|
||||
|
||||
def release(self, capacity_amount):
|
||||
"""Release capacity back to the retry quota.
|
||||
|
||||
The capacity being released will be truncated if necessary
|
||||
to ensure the max capacity is never exceeded.
|
||||
|
||||
"""
|
||||
# Implementation note: The release() method is called as part
|
||||
# of the "after-call" event, which means it gets invoked for
|
||||
# every API call. In the common case where the request is
|
||||
# successful and we're at full capacity, we can avoid locking.
|
||||
# We can't exceed max capacity so there's no work we have to do.
|
||||
if self._max_capacity == self._available_capacity:
|
||||
return
|
||||
with self._lock:
|
||||
amount = min(
|
||||
self._max_capacity - self._available_capacity,
|
||||
capacity_amount
|
||||
)
|
||||
self._available_capacity += amount
|
||||
|
||||
@property
|
||||
def available_capacity(self):
|
||||
return self._available_capacity
|
||||
48
botocore/retries/special.py
Normal file
48
botocore/retries/special.py
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
"""Special cased retries.
|
||||
|
||||
These are additional retry cases we still have to handle from the legacy
|
||||
retry handler. They don't make sense as part of the standard mode retry
|
||||
module. Ideally we should be able to remove this module.
|
||||
|
||||
"""
|
||||
import logging
|
||||
from binascii import crc32
|
||||
from botocore.retries.base import BaseRetryableChecker
|
||||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
# TODO: This is an ideal candidate for the retryable trait once that's
|
||||
# available.
|
||||
class RetryIDPCommunicationError(BaseRetryableChecker):
|
||||
|
||||
_SERVICE_NAME = 'sts'
|
||||
|
||||
def is_retryable(self, context):
|
||||
service_name = context.operation_model.service_model.service_name
|
||||
if service_name != self._SERVICE_NAME:
|
||||
return False
|
||||
error_code = context.get_error_code()
|
||||
return error_code == 'IDPCommunicationError'
|
||||
|
||||
|
||||
class RetryDDBChecksumError(BaseRetryableChecker):
|
||||
|
||||
_CHECKSUM_HEADER = 'x-amz-crc32'
|
||||
_SERVICE_NAME = 'dynamodb'
|
||||
|
||||
def is_retryable(self, context):
|
||||
service_name = context.operation_model.service_model.service_name
|
||||
if service_name != self._SERVICE_NAME:
|
||||
return False
|
||||
if context.http_response is None:
|
||||
return False
|
||||
checksum = context.http_response.headers.get(self._CHECKSUM_HEADER)
|
||||
if checksum is None:
|
||||
return False
|
||||
actual_crc32 = crc32(context.http_response.content) & 0xffffffff
|
||||
if actual_crc32 != int(checksum):
|
||||
logger.debug("DynamoDB crc32 checksum does not match, "
|
||||
"expected: %s, actual: %s", checksum, actual_crc32)
|
||||
return True
|
||||
495
botocore/retries/standard.py
Normal file
495
botocore/retries/standard.py
Normal file
|
|
@ -0,0 +1,495 @@
|
|||
"""Standard retry behavior.
|
||||
|
||||
This contains the default standard retry behavior.
|
||||
It provides consistent behavior with other AWS SDKs.
|
||||
|
||||
The key base classes uses for retries:
|
||||
|
||||
* ``BaseRetryableChecker`` - Use to check a specific condition that
|
||||
indicates a retry should happen. This can include things like
|
||||
max attempts, HTTP status code checks, error code checks etc.
|
||||
* ``RetryBackoff`` - Use to determine how long we should backoff until
|
||||
we retry a request. This is the class that will implement delay such
|
||||
as exponential backoff.
|
||||
* ``RetryPolicy`` - Main class that determines if a retry should
|
||||
happen. It can combine data from a various BaseRetryableCheckers
|
||||
to make a final call as to whether or not a retry should happen.
|
||||
It then uses a ``BaseRetryBackoff`` to determine how long to delay.
|
||||
* ``RetryHandler`` - The bridge between botocore's event system
|
||||
used by endpoint.py to manage retries and the interfaces defined
|
||||
in this module.
|
||||
|
||||
This allows us to define an API that has minimal coupling to the event
|
||||
based API used by botocore.
|
||||
|
||||
"""
|
||||
import random
|
||||
import logging
|
||||
|
||||
from botocore.exceptions import ConnectionError, HTTPClientError
|
||||
from botocore.exceptions import ReadTimeoutError, ConnectTimeoutError
|
||||
from botocore.retries import quota
|
||||
from botocore.retries import special
|
||||
from botocore.retries.base import BaseRetryBackoff, BaseRetryableChecker
|
||||
|
||||
DEFAULT_MAX_ATTEMPTS = 3
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def register_retry_handler(client, max_attempts=DEFAULT_MAX_ATTEMPTS):
|
||||
retry_quota = RetryQuotaChecker(quota.RetryQuota())
|
||||
|
||||
service_id = client.meta.service_model.service_id
|
||||
service_event_name = service_id.hyphenize()
|
||||
client.meta.events.register('after-call.%s' % service_event_name,
|
||||
retry_quota.release_retry_quota)
|
||||
|
||||
handler = RetryHandler(
|
||||
retry_policy=RetryPolicy(
|
||||
retry_checker=StandardRetryConditions(max_attempts=max_attempts),
|
||||
retry_backoff=ExponentialBackoff(),
|
||||
),
|
||||
retry_event_adapter=RetryEventAdapter(),
|
||||
retry_quota=retry_quota,
|
||||
)
|
||||
|
||||
unique_id = 'retry-config-%s' % service_event_name
|
||||
client.meta.events.register(
|
||||
'needs-retry.%s' % service_event_name, handler.needs_retry,
|
||||
unique_id=unique_id
|
||||
)
|
||||
return handler
|
||||
|
||||
|
||||
class RetryHandler(object):
|
||||
"""Bridge between botocore's event system and this module.
|
||||
|
||||
This class is intended to be hooked to botocore's event system
|
||||
as an event handler.
|
||||
"""
|
||||
def __init__(self, retry_policy, retry_event_adapter, retry_quota):
|
||||
self._retry_policy = retry_policy
|
||||
self._retry_event_adapter = retry_event_adapter
|
||||
self._retry_quota = retry_quota
|
||||
|
||||
def needs_retry(self, **kwargs):
|
||||
"""Connect as a handler to the needs-retry event."""
|
||||
retry_delay = None
|
||||
context = self._retry_event_adapter.create_retry_context(**kwargs)
|
||||
if self._retry_policy.should_retry(context):
|
||||
# Before we can retry we need to ensure we have sufficient
|
||||
# capacity in our retry quota.
|
||||
if self._retry_quota.acquire_retry_quota(context):
|
||||
retry_delay = self._retry_policy.compute_retry_delay(context)
|
||||
logger.debug("Retry needed, retrying request after "
|
||||
"delay of: %s", retry_delay)
|
||||
else:
|
||||
logger.debug("Retry needed but retry quota reached, "
|
||||
"not retrying request.")
|
||||
else:
|
||||
logger.debug("Not retrying request.")
|
||||
self._retry_event_adapter.adapt_retry_response_from_context(
|
||||
context)
|
||||
return retry_delay
|
||||
|
||||
|
||||
class RetryEventAdapter(object):
|
||||
"""Adapter to existing retry interface used in the endpoints layer.
|
||||
|
||||
This existing interface for determining if a retry needs to happen
|
||||
is event based and used in ``botocore.endpoint``. The interface has
|
||||
grown organically over the years and could use some cleanup. This
|
||||
adapter converts that interface into the interface used by the
|
||||
new retry strategies.
|
||||
|
||||
"""
|
||||
def create_retry_context(self, **kwargs):
|
||||
"""Create context based on needs-retry kwargs."""
|
||||
response = kwargs['response']
|
||||
if response is None:
|
||||
# If response is None it means that an exception was raised
|
||||
# because we never received a response from the service. This
|
||||
# could be something like a ConnectionError we get from our
|
||||
# http layer.
|
||||
http_response = None
|
||||
parsed_response = None
|
||||
else:
|
||||
http_response, parsed_response = response
|
||||
# This provides isolation between the kwargs emitted in the
|
||||
# needs-retry event, and what this module uses to check for
|
||||
# retries.
|
||||
context = RetryContext(
|
||||
attempt_number=kwargs['attempts'],
|
||||
operation_model=kwargs['operation'],
|
||||
http_response=http_response,
|
||||
parsed_response=parsed_response,
|
||||
caught_exception=kwargs['caught_exception'],
|
||||
request_context=kwargs['request_dict']['context'],
|
||||
)
|
||||
return context
|
||||
|
||||
def adapt_retry_response_from_context(self, context):
|
||||
"""Modify response back to user back from context."""
|
||||
# This will mutate attributes that are returned back to the end
|
||||
# user. We do it this way so that all the various retry classes
|
||||
# don't mutate any input parameters from the needs-retry event.
|
||||
metadata = context.get_retry_metadata()
|
||||
if context.parsed_response is not None:
|
||||
context.parsed_response.setdefault(
|
||||
'ResponseMetadata', {}).update(metadata)
|
||||
|
||||
|
||||
# Implementation note: this is meant to encapsulate all the misc stuff
|
||||
# that gets sent in the needs-retry event. This is mapped so that params
|
||||
# are more clear and explicit.
|
||||
class RetryContext(object):
|
||||
"""Normalize a response that we use to check if a retry should occur.
|
||||
|
||||
This class smoothes over the different types of responses we may get
|
||||
from a service including:
|
||||
|
||||
* A modeled error response from the service that contains a service
|
||||
code and error message.
|
||||
* A raw HTTP response that doesn't contain service protocol specific
|
||||
error keys.
|
||||
* An exception received while attempting to retrieve a response.
|
||||
This could be a ConnectionError we receive from our HTTP layer which
|
||||
could represent that we weren't able to receive a response from
|
||||
the service.
|
||||
|
||||
This class guarantees that at least one of the above attributes will be
|
||||
non None.
|
||||
|
||||
This class is meant to provide a read-only view into the properties
|
||||
associated with a possible retryable response. None of the properties
|
||||
are meant to be modified directly.
|
||||
|
||||
"""
|
||||
def __init__(self, attempt_number, operation_model=None,
|
||||
parsed_response=None, http_response=None,
|
||||
caught_exception=None, request_context=None):
|
||||
# 1-based attempt number.
|
||||
self.attempt_number = attempt_number
|
||||
self.operation_model = operation_model
|
||||
# This is the parsed response dictionary we get from parsing
|
||||
# the HTTP response from the service.
|
||||
self.parsed_response = parsed_response
|
||||
# This is an instance of botocore.awsrequest.AWSResponse.
|
||||
self.http_response = http_response
|
||||
# This is a subclass of Exception that will be non None if
|
||||
# an exception was raised when retrying to retrieve a response.
|
||||
self.caught_exception = caught_exception
|
||||
# This is the request context dictionary that's added to the
|
||||
# request dict. This is used to story any additional state
|
||||
# about the request. We use this for storing retry quota
|
||||
# capacity.
|
||||
if request_context is None:
|
||||
request_context = {}
|
||||
self.request_context = request_context
|
||||
self._retry_metadata = {}
|
||||
|
||||
# These are misc helper methods to avoid duplication in the various
|
||||
# checkers.
|
||||
def get_error_code(self):
|
||||
"""Check if there was a parsed response with an error code.
|
||||
|
||||
If we could not find any error codes, ``None`` is returned.
|
||||
|
||||
"""
|
||||
if self.parsed_response is None:
|
||||
return
|
||||
return self.parsed_response.get('Error', {}).get('Code')
|
||||
|
||||
def add_retry_metadata(self, **kwargs):
|
||||
"""Add key/value pairs to the retry metadata.
|
||||
|
||||
This allows any objects during the retry process to add
|
||||
metadata about any checks/validations that happened.
|
||||
|
||||
This gets added to the response metadata in the retry handler.
|
||||
|
||||
"""
|
||||
self._retry_metadata.update(**kwargs)
|
||||
|
||||
def get_retry_metadata(self):
|
||||
return self._retry_metadata.copy()
|
||||
|
||||
|
||||
class RetryPolicy(object):
|
||||
def __init__(self, retry_checker, retry_backoff):
|
||||
self._retry_checker = retry_checker
|
||||
self._retry_backoff = retry_backoff
|
||||
|
||||
def should_retry(self, context):
|
||||
return self._retry_checker.is_retryable(context)
|
||||
|
||||
def compute_retry_delay(self, context):
|
||||
return self._retry_backoff.delay_amount(context)
|
||||
|
||||
|
||||
class ExponentialBackoff(BaseRetryBackoff):
|
||||
|
||||
_BASE = 2
|
||||
_MAX_BACKOFF = 20
|
||||
|
||||
def __init__(self, max_backoff=20, random=random.random):
|
||||
self._base = self._BASE
|
||||
self._max_backoff = max_backoff
|
||||
self._random = random
|
||||
|
||||
def delay_amount(self, context):
|
||||
"""Calculates delay based on exponential backoff.
|
||||
|
||||
This class implements truncated binary exponential backoff
|
||||
with jitter::
|
||||
|
||||
t_i = min(rand(0, 1) * 2 ** attempt, MAX_BACKOFF)
|
||||
|
||||
where ``i`` is the request attempt (0 based).
|
||||
|
||||
"""
|
||||
# The context.attempt_number is a 1-based value, but we have
|
||||
# to calculate the delay based on i based a 0-based value. We
|
||||
# want the first delay to just be ``rand(0, 1)``.
|
||||
return min(
|
||||
self._random() * (self._base ** (context.attempt_number - 1)),
|
||||
self._max_backoff
|
||||
)
|
||||
|
||||
|
||||
class MaxAttemptsChecker(BaseRetryableChecker):
|
||||
def __init__(self, max_attempts):
|
||||
self._max_attempts = max_attempts
|
||||
|
||||
def is_retryable(self, context):
|
||||
under_max_attempts = context.attempt_number < self._max_attempts
|
||||
if not under_max_attempts:
|
||||
logger.debug("Max attempts of %s reached.", self._max_attempts)
|
||||
context.add_retry_metadata(MaxAttemptsReached=True)
|
||||
return under_max_attempts
|
||||
|
||||
|
||||
class TransientRetryableChecker(BaseRetryableChecker):
|
||||
_TRANSIENT_ERROR_CODES = [
|
||||
'RequestTimeout',
|
||||
'RequestTimeoutException',
|
||||
'PriorRequestNotComplete',
|
||||
]
|
||||
_TRANSIENT_STATUS_CODES = [500, 502, 503, 504]
|
||||
_TRANSIENT_EXCEPTION_CLS = (
|
||||
ConnectionError,
|
||||
HTTPClientError,
|
||||
)
|
||||
|
||||
def __init__(self, transient_error_codes=None,
|
||||
transient_status_codes=None,
|
||||
transient_exception_cls=None):
|
||||
if transient_error_codes is None:
|
||||
transient_error_codes = self._TRANSIENT_ERROR_CODES[:]
|
||||
if transient_status_codes is None:
|
||||
transient_status_codes = self._TRANSIENT_STATUS_CODES[:]
|
||||
if transient_exception_cls is None:
|
||||
transient_exception_cls = self._TRANSIENT_EXCEPTION_CLS
|
||||
self._transient_error_codes = transient_error_codes
|
||||
self._transient_status_codes = transient_status_codes
|
||||
self._transient_exception_cls = transient_exception_cls
|
||||
|
||||
def is_retryable(self, context):
|
||||
if context.get_error_code() in self._transient_error_codes:
|
||||
return True
|
||||
if context.http_response is not None:
|
||||
if context.http_response.status_code in \
|
||||
self._transient_status_codes:
|
||||
return True
|
||||
if context.caught_exception is not None:
|
||||
return isinstance(context.caught_exception,
|
||||
self._transient_exception_cls)
|
||||
return False
|
||||
|
||||
|
||||
class ThrottledRetryableChecker(BaseRetryableChecker):
|
||||
# This is the union of all error codes we've seen that represent
|
||||
# a throttled error.
|
||||
_THROTTLED_ERROR_CODES = [
|
||||
'Throttling',
|
||||
'ThrottlingException',
|
||||
'ThrottledException',
|
||||
'RequestThrottledException',
|
||||
'TooManyRequestsException',
|
||||
'ProvisionedThroughputExceededException',
|
||||
'TransactionInProgressException',
|
||||
'RequestLimitExceeded',
|
||||
'BandwidthLimitExceeded',
|
||||
'LimitExceededException',
|
||||
'RequestThrottled',
|
||||
'SlowDown',
|
||||
'PriorRequestNotComplete',
|
||||
'EC2ThrottledException',
|
||||
]
|
||||
|
||||
def __init__(self, throttled_error_codes=None):
|
||||
if throttled_error_codes is None:
|
||||
throttled_error_codes = self._THROTTLED_ERROR_CODES[:]
|
||||
self._throttled_error_codes = throttled_error_codes
|
||||
|
||||
def is_retryable(self, context):
|
||||
# Only the error code from a parsed service response is used
|
||||
# to determine if the response is a throttled response.
|
||||
return context.get_error_code() in self._throttled_error_codes
|
||||
|
||||
|
||||
class ModeledRetryableChecker(BaseRetryableChecker):
|
||||
"""Check if an error has been modeled as retryable."""
|
||||
|
||||
def __init__(self):
|
||||
self._error_detector = ModeledRetryErrorDetector()
|
||||
|
||||
def is_retryable(self, context):
|
||||
error_code = context.get_error_code()
|
||||
if error_code is None:
|
||||
return False
|
||||
return self._error_detector.detect_error_type(context) is not None
|
||||
|
||||
|
||||
class ModeledRetryErrorDetector(object):
|
||||
"""Checks whether or not an error is a modeled retryable error."""
|
||||
# There are return values from the detect_error_type() method.
|
||||
TRANSIENT_ERROR = 'TRANSIENT_ERROR'
|
||||
THROTTLING_ERROR = 'THROTTLING_ERROR'
|
||||
# This class is lower level than ModeledRetryableChecker, which
|
||||
# implements BaseRetryableChecker. This object allows you to distinguish
|
||||
# between the various types of retryable errors.
|
||||
|
||||
def detect_error_type(self, context):
|
||||
"""Detect the error type associated with an error code and model.
|
||||
|
||||
This will either return:
|
||||
|
||||
* ``self.TRANSIENT_ERROR`` - If the error is a transient error
|
||||
* ``self.THROTTLING_ERROR`` - If the error is a throttling error
|
||||
* ``None`` - If the error is neither type of error.
|
||||
|
||||
"""
|
||||
error_code = context.get_error_code()
|
||||
op_model = context.operation_model
|
||||
if op_model is None or not op_model.error_shapes:
|
||||
return
|
||||
for shape in op_model.error_shapes:
|
||||
if shape.metadata.get('retryable') is not None:
|
||||
# Check if this error code matches the shape. This can
|
||||
# be either by name or by a modeled error code.
|
||||
error_code_to_check = (
|
||||
shape.metadata.get('error', {}).get('code')
|
||||
or shape.name
|
||||
)
|
||||
if error_code == error_code_to_check:
|
||||
if shape.metadata['retryable'].get('throttling'):
|
||||
return self.THROTTLING_ERROR
|
||||
return self.TRANSIENT_ERROR
|
||||
|
||||
|
||||
class ThrottlingErrorDetector(object):
|
||||
def __init__(self, retry_event_adapter):
|
||||
self._modeled_error_detector = ModeledRetryErrorDetector()
|
||||
self._fixed_error_code_detector = ThrottledRetryableChecker()
|
||||
self._retry_event_adapter = retry_event_adapter
|
||||
|
||||
# This expects the kwargs from needs-retry to be passed through.
|
||||
def is_throttling_error(self, **kwargs):
|
||||
context = self._retry_event_adapter.create_retry_context(**kwargs)
|
||||
if self._fixed_error_code_detector.is_retryable(context):
|
||||
return True
|
||||
error_type = self._modeled_error_detector.detect_error_type(context)
|
||||
return error_type == self._modeled_error_detector.THROTTLING_ERROR
|
||||
|
||||
|
||||
class StandardRetryConditions(BaseRetryableChecker):
|
||||
"""Concrete class that implements the standard retry policy checks.
|
||||
|
||||
Specifically:
|
||||
|
||||
not max_attempts and (transient or throttled or modeled_retry)
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, max_attempts=DEFAULT_MAX_ATTEMPTS):
|
||||
# Note: This class is for convenience so you can have the
|
||||
# standard retry condition in a single class.
|
||||
self._max_attempts_checker = MaxAttemptsChecker(max_attempts)
|
||||
self._additional_checkers = OrRetryChecker([
|
||||
TransientRetryableChecker(),
|
||||
ThrottledRetryableChecker(),
|
||||
ModeledRetryableChecker(),
|
||||
OrRetryChecker([
|
||||
special.RetryIDPCommunicationError(),
|
||||
special.RetryDDBChecksumError(),
|
||||
])
|
||||
])
|
||||
|
||||
def is_retryable(self, context):
|
||||
return (self._max_attempts_checker.is_retryable(context) and
|
||||
self._additional_checkers.is_retryable(context))
|
||||
|
||||
|
||||
class OrRetryChecker(BaseRetryableChecker):
|
||||
def __init__(self, checkers):
|
||||
self._checkers = checkers
|
||||
|
||||
def is_retryable(self, context):
|
||||
return any(checker.is_retryable(context) for checker in self._checkers)
|
||||
|
||||
|
||||
class RetryQuotaChecker(object):
|
||||
_RETRY_COST = 5
|
||||
_NO_RETRY_INCREMENT = 1
|
||||
_TIMEOUT_RETRY_REQUEST = 10
|
||||
_TIMEOUT_EXCEPTIONS = (ConnectTimeoutError, ReadTimeoutError)
|
||||
|
||||
# Implementation note: We're not making this a BaseRetryableChecker
|
||||
# because this isn't just a check if we can retry. This also changes
|
||||
# state so we have to careful when/how we call this. Making it
|
||||
# a BaseRetryableChecker implies you can call .is_retryable(context)
|
||||
# as many times as you want and not affect anything.
|
||||
|
||||
def __init__(self, quota):
|
||||
self._quota = quota
|
||||
# This tracks the last amount
|
||||
self._last_amount_acquired = None
|
||||
|
||||
def acquire_retry_quota(self, context):
|
||||
if self._is_timeout_error(context):
|
||||
capacity_amount = self._TIMEOUT_RETRY_REQUEST
|
||||
else:
|
||||
capacity_amount = self._RETRY_COST
|
||||
success = self._quota.acquire(capacity_amount)
|
||||
if success:
|
||||
# We add the capacity amount to the request context so we know
|
||||
# how much to release later. The capacity amount can vary based
|
||||
# on the error.
|
||||
context.request_context['retry_quota_capacity'] = capacity_amount
|
||||
return True
|
||||
context.add_retry_metadata(RetryQuotaReached=True)
|
||||
return False
|
||||
|
||||
def _is_timeout_error(self, context):
|
||||
return isinstance(context.caught_exception, self._TIMEOUT_EXCEPTIONS)
|
||||
|
||||
# This is intended to be hooked up to ``after-call``.
|
||||
def release_retry_quota(self, context, http_response, **kwargs):
|
||||
# There's three possible options.
|
||||
# 1. The HTTP response did not have a 2xx response. In that case we
|
||||
# give no quota back.
|
||||
# 2. The HTTP request was successful and was never retried. In
|
||||
# that case we give _NO_RETRY_INCREMENT back.
|
||||
# 3. The API call had retries, and we eventually receive an HTTP
|
||||
# response with a 2xx status code. In that case we give back
|
||||
# whatever quota was associated with the last acquisition.
|
||||
if http_response is None:
|
||||
return
|
||||
status_code = http_response.status_code
|
||||
if 200 <= status_code < 300:
|
||||
if 'retry_quota_capacity' not in context:
|
||||
self._quota.release(self._NO_RETRY_INCREMENT)
|
||||
else:
|
||||
capacity_amount = context['retry_quota_capacity']
|
||||
self._quota.release(capacity_amount)
|
||||
54
botocore/retries/throttling.py
Normal file
54
botocore/retries/throttling.py
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
from collections import namedtuple
|
||||
|
||||
CubicParams = namedtuple('CubicParams', ['w_max', 'k', 'last_fail'])
|
||||
|
||||
|
||||
class CubicCalculator(object):
|
||||
_SCALE_CONSTANT = 0.4
|
||||
_BETA = 0.7
|
||||
|
||||
def __init__(self, starting_max_rate,
|
||||
start_time,
|
||||
scale_constant=_SCALE_CONSTANT, beta=_BETA):
|
||||
self._w_max = starting_max_rate
|
||||
self._scale_constant = scale_constant
|
||||
self._beta = beta
|
||||
self._k = self._calculate_zero_point()
|
||||
self._last_fail = start_time
|
||||
|
||||
def _calculate_zero_point(self):
|
||||
k = ((self._w_max * (1 - self._beta)) / self._scale_constant) ** (1 / 3.0)
|
||||
return k
|
||||
|
||||
def success_received(self, timestamp):
|
||||
dt = timestamp - self._last_fail
|
||||
new_rate = (
|
||||
self._scale_constant * (dt - self._k) ** 3 + self._w_max
|
||||
)
|
||||
return new_rate
|
||||
|
||||
def error_received(self, current_rate, timestamp):
|
||||
# Consider not having this be the current measured rate.
|
||||
|
||||
# We have a new max rate, which is the current rate we were sending
|
||||
# at when we received an error response.
|
||||
self._w_max = current_rate
|
||||
self._k = self._calculate_zero_point()
|
||||
self._last_fail = timestamp
|
||||
return current_rate * self._beta
|
||||
|
||||
def get_params_snapshot(self):
|
||||
"""Return a read-only object of the current cubic parameters.
|
||||
|
||||
These parameters are intended to be used for debug/troubleshooting
|
||||
purposes. These object is a read-only snapshot and cannot be used
|
||||
to modify the behavior of the CUBIC calculations.
|
||||
|
||||
New parameters may be added to this object in the future.
|
||||
|
||||
"""
|
||||
return CubicParams(
|
||||
w_max=self._w_max,
|
||||
k=self._k,
|
||||
last_fail=self._last_fail
|
||||
)
|
||||
|
|
@ -24,13 +24,13 @@ import socket
|
|||
import cgi
|
||||
|
||||
import dateutil.parser
|
||||
from dateutil.tz import tzlocal, tzutc
|
||||
from dateutil.tz import tzutc
|
||||
|
||||
import botocore
|
||||
import botocore.awsrequest
|
||||
import botocore.httpsession
|
||||
from botocore.compat import json, quote, zip_longest, urlsplit, urlunsplit
|
||||
from botocore.compat import OrderedDict, six, urlparse
|
||||
from botocore.compat import OrderedDict, six, urlparse, get_tzinfo_options
|
||||
from botocore.vendored.six.moves.urllib.request import getproxies, proxy_bypass
|
||||
from botocore.exceptions import (
|
||||
InvalidExpressionError, ConfigNotFound, InvalidDNSNameError, ClientError,
|
||||
|
|
@ -590,6 +590,25 @@ def percent_encode(input_str, safe=SAFE_CHARS):
|
|||
return quote(input_str, safe=safe)
|
||||
|
||||
|
||||
def _parse_timestamp_with_tzinfo(value, tzinfo):
|
||||
"""Parse timestamp with pluggable tzinfo options."""
|
||||
if isinstance(value, (int, float)):
|
||||
# Possibly an epoch time.
|
||||
return datetime.datetime.fromtimestamp(value, tzinfo())
|
||||
else:
|
||||
try:
|
||||
return datetime.datetime.fromtimestamp(float(value), tzinfo())
|
||||
except (TypeError, ValueError):
|
||||
pass
|
||||
try:
|
||||
# In certain cases, a timestamp marked with GMT can be parsed into a
|
||||
# different time zone, so here we provide a context which will
|
||||
# enforce that GMT == UTC.
|
||||
return dateutil.parser.parse(value, tzinfos={'GMT': tzutc()})
|
||||
except (TypeError, ValueError) as e:
|
||||
raise ValueError('Invalid timestamp "%s": %s' % (value, e))
|
||||
|
||||
|
||||
def parse_timestamp(value):
|
||||
"""Parse a timestamp into a datetime object.
|
||||
|
||||
|
|
@ -602,21 +621,14 @@ def parse_timestamp(value):
|
|||
This will return a ``datetime.datetime`` object.
|
||||
|
||||
"""
|
||||
if isinstance(value, (int, float)):
|
||||
# Possibly an epoch time.
|
||||
return datetime.datetime.fromtimestamp(value, tzlocal())
|
||||
else:
|
||||
for tzinfo in get_tzinfo_options():
|
||||
try:
|
||||
return datetime.datetime.fromtimestamp(float(value), tzlocal())
|
||||
except (TypeError, ValueError):
|
||||
pass
|
||||
try:
|
||||
# In certain cases, a timestamp marked with GMT can be parsed into a
|
||||
# different time zone, so here we provide a context which will
|
||||
# enforce that GMT == UTC.
|
||||
return dateutil.parser.parse(value, tzinfos={'GMT': tzutc()})
|
||||
except (TypeError, ValueError) as e:
|
||||
raise ValueError('Invalid timestamp "%s": %s' % (value, e))
|
||||
return _parse_timestamp_with_tzinfo(value, tzinfo)
|
||||
except OSError as e:
|
||||
logger.debug('Unable to parse timestamp with "%s" timezone info.',
|
||||
tzinfo.__name__, exc_info=e)
|
||||
raise RuntimeError('Unable to calculate correct timezone offset for '
|
||||
'"%s"' % value)
|
||||
|
||||
|
||||
def parse_to_aware_datetime(value):
|
||||
|
|
|
|||
|
|
@ -52,9 +52,9 @@ copyright = u'2013, Mitch Garnaat'
|
|||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '1.14.'
|
||||
version = '1.15.'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.14.14'
|
||||
release = '1.15.26'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
|
|||
0
tests/functional/retries/__init__.py
Normal file
0
tests/functional/retries/__init__.py
Normal file
109
tests/functional/retries/test_bucket.py
Normal file
109
tests/functional/retries/test_bucket.py
Normal file
|
|
@ -0,0 +1,109 @@
|
|||
import random
|
||||
import time
|
||||
import threading
|
||||
from tests import unittest
|
||||
|
||||
from botocore.retries import bucket
|
||||
|
||||
|
||||
class InstrumentedTokenBucket(bucket.TokenBucket):
|
||||
def _acquire(self, amount, block):
|
||||
rval = super(InstrumentedTokenBucket, self)._acquire(amount, block)
|
||||
assert self._current_capacity >= 0
|
||||
return rval
|
||||
|
||||
|
||||
class TestTokenBucketThreading(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.shutdown_threads = False
|
||||
self.caught_exceptions = []
|
||||
self.acquisitions_by_thread = {}
|
||||
|
||||
def run_in_thread(self):
|
||||
while not self.shutdown_threads:
|
||||
capacity = random.randint(1, self.max_capacity)
|
||||
self.retry_quota.acquire(capacity)
|
||||
self.seen_capacities.append(self.retry_quota.available_capacity)
|
||||
self.retry_quota.release(capacity)
|
||||
self.seen_capacities.append(self.retry_quota.available_capacity)
|
||||
|
||||
def create_clock(self):
|
||||
return bucket.Clock()
|
||||
|
||||
def test_can_change_max_rate_while_blocking(self):
|
||||
# This isn't a stress test, we just want to verify we can change
|
||||
# the rate at which we acquire a token.
|
||||
min_rate = 0.1
|
||||
max_rate = 1
|
||||
token_bucket = bucket.TokenBucket(
|
||||
min_rate=min_rate, max_rate=max_rate,
|
||||
clock=self.create_clock(),
|
||||
)
|
||||
# First we'll set the max_rate to 0.1 (min_rate). This means that
|
||||
# it will take 10 seconds to accumulate a single token. We'll start
|
||||
# a thread and have it acquire() a token.
|
||||
# Then in the main thread we'll change the max_rate to something
|
||||
# really quick (e.g 100). We should immediately get a token back.
|
||||
# This is going to be timing sensitive, but we can verify that
|
||||
# as long as it doesn't take 10 seconds to get a token, we were
|
||||
# able to update the rate as needed.
|
||||
thread = threading.Thread(target=token_bucket.acquire)
|
||||
token_bucket.max_rate = min_rate
|
||||
start_time = time.time()
|
||||
thread.start()
|
||||
# This shouldn't block the main thread.
|
||||
token_bucket.max_rate = 100
|
||||
thread.join()
|
||||
end_time = time.time()
|
||||
self.assertLessEqual(end_time - start_time, 1.0 / min_rate)
|
||||
|
||||
def acquire_in_loop(self, token_bucket):
|
||||
while not self.shutdown_threads:
|
||||
try:
|
||||
self.assertTrue(token_bucket.acquire())
|
||||
thread_name = threading.current_thread().name
|
||||
self.acquisitions_by_thread[thread_name] += 1
|
||||
except Exception as e:
|
||||
self.caught_exceptions.append(e)
|
||||
|
||||
def randomly_set_max_rate(self, token_bucket, min_val, max_val):
|
||||
while not self.shutdown_threads:
|
||||
new_rate = random.randint(min_val, max_val)
|
||||
token_bucket.max_rate = new_rate
|
||||
time.sleep(0.01)
|
||||
|
||||
def test_stress_test_token_bucket(self):
|
||||
token_bucket = InstrumentedTokenBucket(
|
||||
max_rate=10,
|
||||
clock=self.create_clock(),
|
||||
)
|
||||
all_threads = []
|
||||
for _ in range(2):
|
||||
all_threads.append(
|
||||
threading.Thread(target=self.randomly_set_max_rate,
|
||||
args=(token_bucket, 30, 200))
|
||||
)
|
||||
for _ in range(10):
|
||||
t = threading.Thread(target=self.acquire_in_loop,
|
||||
args=(token_bucket,))
|
||||
self.acquisitions_by_thread[t.name] = 0
|
||||
all_threads.append(t)
|
||||
for thread in all_threads:
|
||||
thread.start()
|
||||
try:
|
||||
# If you're working on this code you can bump this number way
|
||||
# up to stress test it more locally.
|
||||
time.sleep(3)
|
||||
finally:
|
||||
self.shutdown_threads = True
|
||||
for thread in all_threads:
|
||||
thread.join()
|
||||
self.assertEqual(self.caught_exceptions, [])
|
||||
distribution = self.acquisitions_by_thread.values()
|
||||
mean = sum(distribution) / float(len(distribution))
|
||||
# We can't really rely on any guarantees about evenly distributing
|
||||
# thread acquisition(), e.g. must be with a 2 stddev range, but we
|
||||
# can sanity check that our implementation isn't drastically
|
||||
# starving a thread. So we'll arbitrarily say that a thread
|
||||
# can't have less than 30% of the mean allocations per thread.
|
||||
self.assertTrue(not any(x < (0.3 * mean) for x in distribution))
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue